Merge pull request #1063 from oracle/signoz-doc-changes

Signoz doc changes

Author: lake-of-dreams

cloudbank-v4/README.md

@@ -586,72 +586,40 @@ This is an example of the `customer32` application:
 
       ![Admin Server Dashboard](images/admin_server.png  " ")
 
-1. Check Jaeger dashboard
+2. Check the SigNoz Dashboard
 
-   1. Port forward
+   1. Get the *admin* email and password for SigNoz
 
       ```shell
-      kubectl -n observability port-forward svc/jaegertracing-query 16686
-      ```
-
-   1. Open [Jaeger Dashboard](http://localhost:16686) in a browser and verify that all services are registered
-
-      ![Jaeger Dashboard](images/jaeger.png  " ")
-
-   1. Choose `customer` Service and click *Find Traces*
-
-      ![Customer](images/j-traces.png  " ")
-
-1. Check the Grafana Dashboard
-
-   1, Get the *admin* password for Grafana
-
-      ```shell
-      kubectl get secret -n grafana grafana-dashboard-authn -o jsonpath='{.data.password}' | base64 -d
+      kubectl -n observability get secret signoz-authn -o jsonpath='{.data.email}' | base64 -d
+      kubectl -n observability get secret signoz-authn -o jsonpath='{.data.password}' | base64 -d
       ```
 
    1. Port forward
 
       ```shell
-      kubectl -n grafana port-forward svc/grafana 7070:80
+      kubectl -n observability port-forward svc/obaas-signoz-frontend 3301:3301
       ```
 
-   1. Open [Grafana Login](http://localhost:7070/grafana/) in a browser and login with the username *admin* and the password you have retrieved.
+   2. Open [SigNoz Login](http://localhost:3301/login) in a browser and login with the *admin* email and the password you have retrieved.
 
-      ![Grafana Login](images/grafana_login.png  " ")
+      ![SigNoz Login](images/signoz_login.png  " ")
 
-   1. Explore the pre-installed dashboards.
+   3. Explore the pre-installed dashboards.
 
-      ![Grafana](images/grafana-dashboard.png  " ")
-
-1. Check Prometheus dashboard
-
-   1. Port forward
+      ![SigNoz](images/signoz-dashboard.png  " ")
 
-      ```shell
-      kubectl port-forward -n prometheus svc/prometheus 9090
-      ```
-
-   1. Open [Prometheus Dashboard](http://localhost:9090)
-
-      ![Prometheus Dashboard](images/prometheus.png  " ")
-
-   1. Select `application_ready_time_seconds` in the search bar and click *Execute*. You should get a table back with some data about the cloudbank application deployed.
-
-      ![Prometheus DAta](images/prom_data.png  " ")
-
-1. Check Hashicorp Vault dashboard (Development mode)
-
-   1. Port forward
-
-      ```shell
-      kubectl port-forward -n vault svc/vault 8200
-      ```
+   4. Explore the traces view. Choose `customer` Service to view traces related to Customer microservice.
 
-   1. Open [Hashicorp Vault Login](https://localhost:8200) and login using the Token method with the `root`
+      ![Trace Explorer](images/traces.png  " ")
+      
+      Click any of the traces to expand its details.
 
-      ![Vault Login](images/vault_login.png  " ")
+      ![Customer](images/traces-expand.png  " ")
+   5. Explore the logs view. Choose `customer` Service to view logs related to Customer microservice.
 
-   1. You should now see the Hashicorp Vault dashboard
+      ![Logs Explorer](images/logs.png  " ")
+      
+      Click any of the log lines to expand its details.
 
-      ![Vault Dashboard](images/vault_dashboard.png  " ")
+      ![Customer](images/logs-expand.png  " ")

cloudbank-v4/images/grafana-dashboard.png

@@ -13,34 +13,31 @@ Oracle Backend for Microservices and AI includes a number of platform services w
 
     ```shell
     $ kubectl get ns
-      NAME                              STATUS   AGE
-      admin-server                      Active   4h56m
-      apisix                            Active   4h56m
-      application                       Active   4h57m
-      azn-server                        Active   4h56m
-      cert-manager                      Active   4h59m
-      coherence                         Active   4h56m
-      conductor-server                  Active   4h56m
-      config-server                     Active   4h55m
-      default                           Active   5h8m
-      eureka                            Active   4h57m
-      grafana                           Active   4h55m
-      ingress-nginx                     Active   4h57m
-      kafka                             Active   4h56m
-      kaniko                            Active   5h1m
-      kube-node-lease                   Active   5h8m
-      kube-public                       Active   5h8m
-      kube-state-metrics                Active   4h57m
-      kube-system                       Active   5h8m
-      metrics-server                    Active   4h57m
-      obaas-admin                       Active   4h55m
-      observability                     Active   4h55m
-      open-telemetry                    Active   4h55m
-      oracle-database-exporter          Active   4h55m
-      oracle-database-operator-system   Active   4h59m
-      otmm                              Active   4h55m
-      prometheus                        Active   4h57m
-      vault                             Active   4h54m
+    NAME                              STATUS   AGE
+    admin-server                      Active   62d
+    apisix                            Active   22d
+    application                       Active   37d
+    azn-server                        Active   62d
+    cert-manager                      Active   62d
+    coherence                         Active   62d
+    conductor-server                  Active   62d
+    config-server                     Active   62d
+    default                           Active   68d
+    eureka                            Active   62d
+    external-secrets                  Active   47d
+    ingress-nginx                     Active   62d
+    kafka                             Active   62d
+    kaniko                            Active   62d
+    kube-node-lease                   Active   68d
+    kube-public                       Active   68d
+    kube-state-metrics                Active   62d
+    kube-system                       Active   68d
+    metrics-server                    Active   62d
+    obaas-admin                       Active   62d
+    observability                     Active   14d
+    oracle-database-exporter          Active   62d
+    oracle-database-operator-system   Active   62d
+    otmm                              Active   62d
     ```
 
    Here is a summary of what is in each of these namespaces:
@@ -53,16 +50,12 @@ Oracle Backend for Microservices and AI includes a number of platform services w
       * `conductor-server` contains Netflix Conductor OSS which can be used to manage workflows
       * `config-server` contains the Spring CLoud Config Server
       * `eureka` contains the Spring Eureka Service Registry which is used for service discovery
-      * `grafana` contains Grafana which can be used to monitor and manage your environment
       * `ingress-nginx` contains the NGINX ingress controller which is used to manage external access to the cluster
       * `kafka` contains a three-node Kafka cluster that can be used by your application
       * `obaas-admin` contains the Oracle Backend for Microservices and AI administration server that manages deployment of your services
-      * `observability` contains Jaeger tracing which is used for viewing distributed traces
-      * `open-telemetry` contains the Open Telemetry Collector which is used to collect distributed tracing information for your services
+      * `observability` contains SigNoz tracing which is used for viewing distributed logs,traces and metrics.
       * `oracle-database-operator-system` contains the Oracle Database Operator for Kubernetes which can be used to manage Oracle Databases in Kubernetes environments
       * `otmm` contains Oracle Transaction Manager for Microservices which is used to manage transactions across services
-      * `prometheus` contains Prometheus which collects metrics about your services and makes the available to Grafana for alerting and dashboards
-      * `vault` contains HashiCorp Vault which can be used to store secret or sensitive information for services, like credentials for example
 
    Kubernetes namespaces contain other resources like pods, services, secrets and config maps.  You will explore some of these now.
 

cloudbank-v4/images/grafana_login.png

@@ -0,0 +1,43 @@
++++
+archetype = "page"
+title = "Explore SigNoz"
+weight = 8
++++
+
+SigNoz provides an easy way to access the logs, traces and metrics collected in the backend and to view them in dashboards.  It can be used to monitor performance, as well as to identify and analyze problems and to create alerts.
+
+1. Explore the pre-installed Spring Boot Dashboard
+
+    Get the admin email and password for SigNoz using this command:
+
+    ```shell
+    $ kubectl -n observability get secret signoz-authn -o jsonpath='{.data.email}' | base64 -d
+    $ kubectl -n observability get secret signoz-authn -o jsonpath='{.data.password}' | base64 -d
+    ```
+
+   Start the tunnel using this command.  You can run this in the background if you prefer.
+
+    ```shell
+    $ kubectl -n observability port-forward svc/obaas-signoz-frontend 3301:3301
+    ```
+
+   Open a web browser to [http://localhost:3301/login](http://localhost:3301/login) to view the SigNoz web user interface.  It will appear similar to the image below.  Log in with the admin email and the password you just got.
+
+   ![SigNoz Sign-in](../images/obaas-signoz-signin.png " ")
+
+   After signing in you will get to the SigNoz homepage.
+
+   ![picture](../images/obaas-signoz-home-page.png " ")ma
+
+   On the left, click on Dashboards to set the list of pre-installed dashboards.
+
+   ![SigNoz Dashboards](../images/obaas-signoz-dashboards.png " ")
+
+    click on the link to **Spring Boot 3.x Statistics** to see Spring Boot information.
+
+   The Spring Boot Dashboard looks like the image below.  Use the **app_name** selector at the top to choose which microservice you wish to view information for.
+
+   ![picture](../images/obaas-signoz-spring-dashboard.png " ")
+
+   Feel free to explore the other dashboards that are preinstalled.
+

cloudbank-v4/images/j-traces.png

@@ -89,7 +89,7 @@ weight = 3
     You'll see four top classes of resources that can be exploded in underlying items:
     * **applications**: the list of applications deployed and the services holding
     * **Oracle DB**: in this release we have one Database in which are stored configuration and schema related to services deployed
-    * **platformServices**: the list of Oracle Backend for Microservices and AI deployed services, like Grafana, Spring, Apisix, Eureka and Jaeger.
+    * **platformServices**: the list of Oracle Backend for Microservices and AI deployed services, like SigNoz, Spring, Apisix and Eureka.
     * **oBaasConf**: the list of keys defined by application, stored in the ADB provisioned and available to share configuration information among services in each application.
 
     Let's go to show the operations you can do on each item of browse tree.

cloudbank-v4/images/logs-expand.png

@@ -56,7 +56,7 @@ that only requires a single OCI Compute Instance, please use the "Free Tier" opt
 1. If you check the checkbox *Set Administrator Passwords* in the **Administrator Passwords** section you have the option to fill in the following passwords (if not they are autogenerated):
 
     * `APISIX Administrator Password` (optional) : Leave blank to auto-generate.
-    * `Grafana Administrator Password` (optional) : Leave blank to auto-generate.
+    * `SigNoz Administrator Password` (optional) : Leave blank to auto-generate.
     * `ORACTL Administrator Password` (optional) : Leave blank to auto-generate. This is the password for the `obaas-admin` user.
     * `ORACTL User Password` (optional) : Leave blank to auto-generate. This is the password for the `obaas-user` user.
 
@@ -133,7 +133,7 @@ that only requires a single OCI Compute Instance, please use the "Free Tier" opt
     adb_ip = "Secured Access"
     adb_name = "KATYDIDDB"
     apisix_admin_password = <sensitive>
-    grafana_admin_password = <sensitive>
+    signoz_admin_password = <sensitive>
     kubeconfig_cmd = "oci ce cluster create-kubeconfig --cluster-id ocid1.cluster.oc1... --region us-ashburn-1 --token-version 2.0.0 --kube-endpoint PUBLIC_ENDPOINT --file $HOME/.kube/config"
     oractl_admin_password = <sensitive>
     oractl_user_password = <sensitive>

cloudbank-v4/images/logs.png

@@ -0,0 +1,5 @@
+module example.com
+
+go 1.21.5
+
+require github.com/McShelby/hugo-theme-relearn v0.0.0-20250601093205-4407b4364ab6 // indirect

cloudbank-v4/images/prom_data.png

@@ -0,0 +1,2 @@
+github.com/McShelby/hugo-theme-relearn v0.0.0-20250601093205-4407b4364ab6 h1:ASmbykNXuR8lWEKRAs1KZCOqy7OoTeGfKn/02KRTyEY=
+github.com/McShelby/hugo-theme-relearn v0.0.0-20250601093205-4407b4364ab6/go.mod h1:mKQQdxZNIlLvAj8X3tMq+RzntIJSr9z7XdzuMomt0IM=

cloudbank-v4/images/prometheus.png

@@ -33,3 +33,7 @@ weight = 12
 name = "<i class='fa-fw fas fa-bullhorn'></i> Credits"
 url = "more/credits/"
 weight = 30
+
+[module]
+  [[module.imports]]
+    path = 'github.com/McShelby/hugo-theme-relearn'

cloudbank-v4/images/signoz-dashboard.png

@@ -44,10 +44,8 @@ Infrastructure (OCI) Container Engine for Kubernetes cluster (OKE cluster):
 - [Oracle AI Explorer for Apps](platform/aiexpforapps/)
 - [Apache APISIX API Gateway and Dashboard](platform/apigw/)
 - [Apache Kafka](https://kafka.apache.org/)
-- [Grafana](observability/metrics/)
-- [Jaeger](observability/tracing/)
+- [SigNoz](observability/signoz/)
 - [Apache Kafka](https://kafka.apache.org)
-- Loki
 - [Netflix Conductor](platform/conductor/)
 - [OpenTelemetry Collector](observability/tracing/)
 - [Oracle Autonomous Database Serverless](database/)
@@ -57,8 +55,6 @@ Infrastructure (OCI) Container Engine for Kubernetes cluster (OKE cluster):
 - [Oracle Database Operator for Kubernetes (OraOperator or the operator)](https://github.com/oracle/oracle-database-operator)
 - [Oracle Database Observability Exporter](https://github.com/oracle/oracle-db-appdev-monitoring)
 - [Oracle Transaction Manager for Microservices (MicroTx)](platform/microtx/)
-- [Prometheus](observability/metrics/)
-- Promtail
 - [Spring Boot Admin dashboard](platform/spring-admin/)
 - [Spring Cloud Config server](platform/config/)
 - [Spring Cloud Eureka service registry](platform/eureka/)

cloudbank-v4/images/signoz_login.png

@@ -17,8 +17,7 @@ Oracle Backend for Microservices and AI provides the following services that app
 * Spring Cloud Config Server to serve externalized configuration information to applications. This stores the configuration data in the Oracle Autonomous Database instance associated with the backend.
 * Netflix Conductor OSS for running workflows to orchestrate your services.
 * Spring Admin for monitoring your services.
-* Prometheus and Grafana for collecting and visualizing metrics and for alerting.
-* Jaeger and Open Telemetry (OTEL) for distributed tracing. Applications deployed to the Oracle Backend for Microservices and AI may use Jaeger or OTEL for distributed tracing. See the [Environment Variables page](envvars) for variables that can be used.
+* SigNoz for collecting and visualizing metrics, logs and traces.
 
 An integrated development environment is recommended for developing applications. Oracle recommends Visual Studio Code or IntelliJ.
 

cloudbank-v4/images/traces-expand.png

@@ -28,10 +28,8 @@ The predefined variables are as follows:
   This tells the Eureka discovery client to make a local copy of the registry by fetching it from the Eureka server.
 - `eureka.client.service-url.defaultZone`, for example `http://eureka.eureka:8761/eureka`.  
   This is the default zone for the Eureka discovery client.
-- `zipkin.base-url`, for example `http://jaegertracing-collector.observability.svc.cluster.local:9411/api/v2/spans`.  
-  This is the URL of the Zipkin-compatible trace collector which can be used by your application to send trace data to the platform.
-- `otel.exporter.otlp.endpoint`, for example `http://open-telemetry-opentelemetry-collector.open-telemetry:4318/v1/traces`.  
-  This is the URL of the OpenTelemetry (OTLP protocol) trace collector which can be used by your application to send trace data to the platform.
+- `OTEL_EXPORTER_OTLP_ENDPOINT`, for example `http://obaas-signoz-otel-collector.observability:4318`.  
+  This is the URL of the OpenTelemetry (OTLP protocol) collector which can be used by your application to send observability data to the the SigNoz platform.
 - `config.server.url`, for example `http://config-server.config-server.svc.cluster.local:8080`.  
   This is the URL of the Spring Config Server provided by the platform.
 - `liquibase.datasource.username`, for example set to the key `db.username` in secret `admin-liquibasedb-secrets`.  

cloudbank-v4/images/traces.png

@@ -5,9 +5,8 @@ description: "Observability for Spring Boot applications with the Oracle Backend
 keywords: "observability metrics tracing spring springboot microservices development oracle backend"
 ---
 
-Oracle Backend for Microservices and AI includes a number of common open source components to provide application observability including Prometheus, Grafana, Jaeger, and OpenTelemetry Collector.
+Oracle Backend for Microservices and AI includes [SigNoz](https://github.com/SigNoz/signoz) to provide application observability.
 
 For more details, read the following:
 
-* [Metrics](./metrics)
-* [Tracing](./tracing)
+* [SigNoz](./signoz/)