Skip to content

Commit

Permalink
RDoc-2533_prometheusIntegration - finalization
Browse files Browse the repository at this point in the history
  • Loading branch information
reebhub committed Nov 23, 2023
1 parent 44b5bff commit 2771765
Show file tree
Hide file tree
Showing 6 changed files with 37 additions and 8 deletions.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Prometheus
# Monitoring: Prometheus

---

Expand Down Expand Up @@ -35,14 +35,15 @@ alerts related to it or forwarding it to analysis services.

{PANEL: RavenDB Prometheus Endpoint}

The path to the Prometheus endpoint of a RavenDB instance is `/admin/monitoring/v1/prometheus`
To inspect the endpoint's output using a browser follow the RavenDB server's URL with the endpoint path.
The path to the Prometheus endpoint of a RavenDB instance is: `/admin/monitoring/v1/prometheus`
To inspect the endpoint's output using a browser, add the endpoint path to the RavenDB server's URL.
E.g. [http://live-test.ravendb.net/admin/monitoring/v1/prometheus](http://live-test.ravendb.net/admin/monitoring/v1/prometheus)

![RavenDB: Prometheus Endpoint Output](images/ravendb_prometheus-endpoint-output.png "RavenDB: Prometheus Endpoint Output")

* As prometheus handles only numeric values, the endpoint outputs all values as numbers,
providing legends that explain what the numbers mean.
Metrics values are also detailed in the table below.
Metrics values are also explained in the [table below](../../../server/administration/monitoring/prometheus#metrics-provided-by-the-prometheus-endpoint).

## Omit or Include Selected Metrics

Expand Down Expand Up @@ -170,7 +171,9 @@ Here is the list of metrics made available by the `/admin/monitoring/v1/promethe
{PANEL: Using the RavenDB Endpoint by a Prometheus Server}

To direct a Prometheus server to the Prometheus endpoint of a RavenDB instance
add an entry to the Prometheus `yml` configuration file.
[add an entry](https://prometheus.io/docs/prometheus/latest/configuration/configuration/#scrape_config)
to the Prometheus `yml` configuration file.

* **Prometheus.yml**:
{CODE-BLOCK:json}
- job_name: "local-raven-instance"
Expand Down Expand Up @@ -216,9 +219,22 @@ add an entry to the Prometheus `yml` configuration file.

## Fetching Additional RavenDB Information

To get additional details about a RavenDB server, Pass Prometheus: `ravendb_server_info`
The returned value will always be 1, but additional information will appear beneath it.
To retrieve additional information about RavenDB, including its version,
HTTP and TCP URLs, and other details, pass Prometheus: `ravendb_server_info`

![Additional Information](images/additional-info.png "Additional Information")

{PANEL/}

## Related Articles

### Monitoring
- [RavenDB Telegraf Plugin](../../../server/administration/monitoring/telegraf)

### Administration
- [SNMP Administration](../../../server/administration/SNMP/snmp)
- [Zabbix](../../../server/administration/SNMP/setup-zabbix)

### Integrations
- [PostgreSQL Overview](../../../integrations/postgresql-protocol/overview)
- [Power BI](../../../integrations/postgresql-protocol/power-bi)
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# RavenDB Telegraf Plugin
# Monitoring: Telegraf Plugin

---

Expand Down Expand Up @@ -147,3 +147,16 @@ The following is a list of JSON fields returned by the endpoints:
| `server` | `uptime_in_sec` | Server up-time |

{PANEL/}

## Related Articles

### Monitoring
- [Prometheus](../../../server/administration/monitoring/prometheus)

### Administration
- [SNMP Administration](../../../server/administration/SNMP/snmp)
- [Zabbix](../../../server/administration/SNMP/setup-zabbix)

### Integrations
- [PostgreSQL Overview](../../../integrations/postgresql-protocol/overview)
- [Power BI](../../../integrations/postgresql-protocol/power-bi)

0 comments on commit 2771765

Please sign in to comment.