Skip to content

Commit 791c71c

Browse files
committed
Documentation updates
1 parent befd306 commit 791c71c

35 files changed

+1163
-79
lines changed

docs-source/site/docs/deploy/buildpushapp.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,3 +68,8 @@ If the build and push is successful, you should get a message similar to this:
6868
[INFO] Finished at: 2025-09-24T12:18:53-05:00
6969
[INFO] ------------------------------------------------------------------------
7070
```
71+
72+
## Getting Help
73+
74+
- [#oracle-db-microservices Slack channel](https://oracledevs.slack.com/archives/C06L9CDGR6Z) in the Oracle Developers slack workspace.
75+
- [Open an issue in GitHub](https://github.com/oracle/microservices-datadriven/issues/new).

docs-source/site/docs/deploy/dbaccess.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,15 @@ This step is only necessary if your application is connecting to a database.
1010

1111
If your application needs database access, first obtain the database user credentials. Then create a Kubernetes secret containing those credentials. The secret is referenced in your application deployment.
1212

13+
:::note Namespace Configuration
14+
All `kubectl` commands in this guide use `-n obaas-dev` as an example namespace. Replace `obaas-dev` with your actual application namespace in all commands.
15+
16+
To verify your namespaces, run:
17+
```bash
18+
kubectl get namespaces
19+
```
20+
:::
21+
1322
### Create the secret for the application
1423

1524
Create a secret with database access information. This secret is used by the application configuration and is injected during deployment.
@@ -177,3 +186,8 @@ spec:
177186
secret:
178187
secretName: obaas-adb-tns-admin-1
179188
```
189+
190+
## Getting Help
191+
192+
- [#oracle-db-microservices Slack channel](https://oracledevs.slack.com/archives/C06L9CDGR6Z) in the Oracle Developers slack workspace.
193+
- [Open an issue in GitHub](https://github.com/oracle/microservices-datadriven/issues/new).

docs-source/site/docs/deploy/deployapp.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,3 +59,8 @@ obaas:
5959
- `EUREKA_CLIENT_FETCH_REGISTRY`
6060
- `EUREKA_CLIENT_SERVICE_URL_DEFAULTZONE`
6161
- `EUREKA_INSTANCE_HOSTNAME`
62+
63+
## Getting Help
64+
65+
- [#oracle-db-microservices Slack channel](https://oracledevs.slack.com/archives/C06L9CDGR6Z) in the Oracle Developers slack workspace.
66+
- [Open an issue in GitHub](https://github.com/oracle/microservices-datadriven/issues/new).

docs-source/site/docs/deploy/introflow.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,3 +30,8 @@ To deploy an application to OBaaS, follow this high-level workflow:
3030
- Update Chart.yaml with the application name.
3131
- Update values.yaml to match your configuration.
3232
- Install the Helm chart.
33+
34+
## Getting Help
35+
36+
- [#oracle-db-microservices Slack channel](https://oracledevs.slack.com/archives/C06L9CDGR6Z) in the Oracle Developers slack workspace.
37+
- [Open an issue in GitHub](https://github.com/oracle/microservices-datadriven/issues/new).

docs-source/site/docs/intro.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,3 +37,8 @@ Deploy on Oracle Cloud Infrastructure, other cloud providers, or hybrid environm
3737
### Simplified Operations
3838

3939
OBaaS vastly simplifies the task of building, testing, and operating microservices platforms. From development through production, automated workflows and integrated tooling streamline every phase of the application lifecycle.
40+
41+
## Getting Help
42+
43+
- [#oracle-db-microservices Slack channel](https://oracledevs.slack.com/archives/C06L9CDGR6Z) in the Oracle Developers slack workspace.
44+
- [Open an issue in GitHub](https://github.com/oracle/microservices-datadriven/issues/new).

docs-source/site/docs/observability/acces.md

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,23 @@ sidebar_position: 2
44
---
55
## How to access SigNoz
66

7-
1. Get the _admin_ email and password for SigNoz. Replace the example namespace `observability` with the namespace where SigNoz is deployed.
7+
:::note Namespace Configuration
8+
All `kubectl` commands in this guide use `-n observability` as the default namespace. If SigNoz is installed in a different namespace, replace `observability` with your actual namespace name in all commands.
9+
10+
To find your namespace, run:
11+
```bash
12+
kubectl get pods -A | grep signoz
13+
```
14+
:::
15+
16+
1. Get the _admin_ email and password for SigNoz:
817

918
```shell
1019
kubectl -n observability get secret signoz-authn -o jsonpath='{.data.email}' | base64 -d
1120
kubectl -n observability get secret signoz-authn -o jsonpath='{.data.password}' | base64 -d
1221
```
1322

14-
1. Expose the SigNoz user interface (UI) using this command. Replace the example namespace `observability` with the namespace where SigNoz is deployed:
23+
1. Expose the SigNoz user interface (UI) using this command:
1524

1625
```shell
1726
kubectl -n observability port-forward svc/obaas-signoz-frontend 3301:3301
@@ -20,3 +29,8 @@ sidebar_position: 2
2029
1. Open [SigNoz Login](http://localhost:3301/login) in a browser and login with the _admin_ email and the _password_ you have retrieved.
2130

2231
![SigNoz UI](images/obaas-signoz-ui.png)
32+
33+
## Getting Help
34+
35+
- [#oracle-db-microservices Slack channel](https://oracledevs.slack.com/archives/C06L9CDGR6Z) in the Oracle Developers slack workspace.
36+
- [Open an issue in GitHub](https://github.com/oracle/microservices-datadriven/issues/new).

docs-source/site/docs/observability/configure.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -205,3 +205,8 @@ It also adds the `OTEL_EXPORTER_OTLP_ENDPOINT` to pod environment variables for
205205
- name: OTEL_EXPORTER_OTLP_ENDPOINT
206206
value: http://obaas-signoz-otel-collector.observability:4318
207207
```
208+
209+
## Getting Help
210+
211+
- [#oracle-db-microservices Slack channel](https://oracledevs.slack.com/archives/C06L9CDGR6Z) in the Oracle Developers slack workspace.
212+
- [Open an issue in GitHub](https://github.com/oracle/microservices-datadriven/issues/new).

docs-source/site/docs/observability/dashboards.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -197,3 +197,8 @@ Details about Transaction Manager for Microservices(https://docs.oracle.com/en/d
197197

198198
![MicroTx Dashboard](images/microtx-dashboard.png)
199199

200+
## Getting Help
201+
202+
- [#oracle-db-microservices Slack channel](https://oracledevs.slack.com/archives/C06L9CDGR6Z) in the Oracle Developers slack workspace.
203+
- [Open an issue in GitHub](https://github.com/oracle/microservices-datadriven/issues/new).
204+
Lines changed: 43 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,49 @@
11
---
2-
title: Oracle Database Metrics Exporter
2+
title: Oracle Database Metrics Exporter
33
sidebar_position: 6
44
---
55
## Oracle Database Metrics Exporter
66

7-
Oracle Database Metrics Exporter aims to provide observability for the Oracle Database so that users can understand performance and diagnose issues easily across applications and the database. Oracle Database Metrics Exporter delivers functionality to support both cloud and on-premises databases, including those running in Kubernetes and containers.
7+
The Oracle Database Metrics Exporter is a key observability component that provides comprehensive metrics collection for Oracle Database. It helps users understand database performance and diagnose issues easily across applications and the database, supporting both cloud and on-premises deployments, including databases running in Kubernetes and containers.
88

9-
See the [documentation](https://oracle.github.io/oracle-db-appdev-monitoring/) for how to install and configure Oracle Database Metrics Exporter.
9+
:::info Complete Documentation Available
10+
This exporter is documented in detail in the **[Platform Components](../platform/dbexporter.md)** section. For complete installation instructions, testing procedures, troubleshooting guidance, and dashboard configuration, please refer to the comprehensive guide:
11+
12+
**[→ Oracle Database Metrics Exporter - Full Documentation](../platform/dbexporter.md)**
13+
:::
14+
15+
## Quick Links
16+
17+
- **[Installation Guide](../platform/dbexporter.md#installing-oracle-database-metrics-exporter)** - Enable and deploy the exporter
18+
- **[Testing Guide](../platform/dbexporter.md#testing-oracle-database-metrics-exporter)** - Verify metrics collection
19+
- **[Dashboards](../platform/dbexporter.md#dashboards)** - View pre-built Grafana dashboards
20+
- **[Troubleshooting](../platform/dbexporter.md#troubleshooting)** - Common issues and solutions
21+
- **[Official Documentation](https://github.com/oracle/oracle-db-appdev-monitoring)** - Oracle's GitHub repository
22+
23+
## What Metrics Are Available
24+
25+
The exporter provides Prometheus-formatted metrics including:
26+
27+
- **Database connectivity** - `oracledb_up` - Database instance reachability
28+
- **Session metrics** - `oracledb_sessions_*` - Active sessions and session statistics
29+
- **Tablespace metrics** - `oracledb_tablespace_*` - Tablespace usage and capacity
30+
- **Activity metrics** - `oracledb_activity_*` - Database activity and performance
31+
- **Transactional Event Queue metrics** - TxEventQ throughput and queue statistics
32+
33+
These metrics are exposed on port 9161 and automatically scraped by Prometheus when properly configured.
34+
35+
## Integration with OBaaS Observability
36+
37+
The Database Metrics Exporter integrates seamlessly with the OBaaS observability stack:
38+
39+
1. **Prometheus** automatically discovers and scrapes metrics from the exporter
40+
2. **SigNoz** provides pre-built dashboards for visualizing database performance
41+
3. **Service Discovery** ensures metrics are collected from all database instances
42+
4. **Alert Manager** can trigger alerts based on database metric thresholds
43+
44+
For the complete setup and configuration, see the **[full documentation](../platform/dbexporter.md)**.
45+
46+
## Getting Help
47+
48+
- [#oracle-db-microservices Slack channel](https://oracledevs.slack.com/archives/C06L9CDGR6Z) in the Oracle Developers slack workspace.
49+
- [Open an issue in GitHub](https://github.com/oracle/microservices-datadriven/issues/new).

docs-source/site/docs/observability/metricslogstraces.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,3 +37,8 @@ Traces can be filtered based on Service, HTTP Routes etc. Click on a trace to se
3737
![SigNoz Traces Details](images/signoz-traces-details.png)
3838

3939
Logs for a trace event can directly be accessed using the _Go to related logs_ link.
40+
41+
## Getting Help
42+
43+
- [#oracle-db-microservices Slack channel](https://oracledevs.slack.com/archives/C06L9CDGR6Z) in the Oracle Developers slack workspace.
44+
- [Open an issue in GitHub](https://github.com/oracle/microservices-datadriven/issues/new).

0 commit comments

Comments
 (0)