Skip to content

Commit 5dce47d

Browse files
authored
Add grafana picture (#1026)
1 parent f925f27 commit 5dce47d

File tree

2 files changed

+5
-3
lines changed

2 files changed

+5
-3
lines changed

docs-source/transactional-event-queues/content/observability/exporter.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,20 +15,22 @@ To get started with the database exporter, see the [installation](https://github
1515

1616
The database exporter supports [custom metric definitions](https://github.com/oracle/oracle-db-appdev-monitoring/tree/main?tab=readme-ov-file#custom-metrics) in the form of TOML files. The [TxEventQ custom metrics file](https://github.com/oracle/oracle-db-appdev-monitoring/blob/main/custom-metrics-example/txeventq-metrics.toml) contains metrics definitions for queue information like total number of queues, enqueued messages, dequeued messages, and more. You can include the TxEventQ metrics in the database exporter by using the `custom.metrics` program argument and passing the file location:
1717

18-
```
18+
```text
1919
--custom.metrics=txeventq-metrics.toml
2020
```
2121

2222
Or, set the `CUSTOM_METRICS` environment variable to point to custom metric files:
2323

24-
```
24+
```text
2525
CUSTOM_METRICS=txeventq-metrics.toml
2626
```
2727

2828
To add more TxEventQ metrics, you can create a custom metrics file based on the views described in the [TxEventQ Administrative Views](./views.md) section and then provide that file to the database exporter.
2929

3030
## Sample Grafana Dashboard
3131

32-
The [Sample Dashboard for TxEventQ](https://github.com/oracle/oracle-db-appdev-monitoring/blob/main/docker-compose/grafana/dashboards/txeventq.json) visualizes database queueing metrics, and requires the custom metrics definitions located in the [TxEventQ custom metrics file](https://github.com/oracle/oracle-db-appdev-monitoring/blob/main/custom-metrics-example/txeventq-metrics.toml) to be loaded into the database exporter.
32+
The [Sample Dashboard for TxEventQ](https://github.com/oracle/oracle-db-appdev-monitoring/blob/main/docker-compose/grafana/dashboards/txeventq.json) visualizes database queueing metrics, and requires the custom metrics definitions located in the [TxEventQ custom metrics file](https://github.com/oracle/oracle-db-appdev-monitoring/blob/main/custom-metrics-example/txeventq-metrics.toml) to be loaded into the database exporter.
3333

3434
The dashboard can be loaded into a Grafana instance to visualize TxEventQ status, throughput, and subscriber information for a given queue.
35+
36+
![Sample Dashboard for TxEventQ](../images/TxEventQGrafana.png " ")
Loading

0 commit comments

Comments
 (0)