diff --git a/Documentation/5.4/Raven.Documentation.Pages/server/administration/SNMP/snmp.markdown b/Documentation/5.4/Raven.Documentation.Pages/server/administration/SNMP/snmp.markdown index e348889ceb..df23db1ae8 100644 --- a/Documentation/5.4/Raven.Documentation.Pages/server/administration/SNMP/snmp.markdown +++ b/Documentation/5.4/Raven.Documentation.Pages/server/administration/SNMP/snmp.markdown @@ -49,7 +49,7 @@ SNMP support is available for [Enterprise](../../../start/licensing/licensing-ov {PANEL: Enabling SNMP in RavenDB} -* To monitor RavenDB using SNMP you __must__ first set the [Monitoring.Snmp.Enabled](../../../server/configuration/monitoring-configuration#monitoring.snmp.enabled) configuration key to _true_. +* To monitor RavenDB using SNMP you **must** first set the [Monitoring.Snmp.Enabled](../../../server/configuration/monitoring-configuration#monitoring.snmp.enabled) configuration key to _true_. * To learn how to modify a configuration key, refer to the [Configuration Overview](../../../server/configuration/configuration-options) article, which outlines all available options. @@ -111,7 +111,7 @@ There are several configurable SNMP properties in RavenDB: {INFO: } -* See article [Monitoring Options](../../../server/configuration/monitoring-configuration) for the full list of __SNMP configuration keys__. +* See article [Monitoring Options](../../../server/configuration/monitoring-configuration) for the full list of **SNMP configuration keys**. * To learn how to modify a configuration key, refer to the [Configuration Overview](../../../server/configuration/configuration-options) article, which outlines all available options. @@ -176,7 +176,7 @@ snmpget -v 3 -l authNoPriv -u ravendb -a SHA \ --- -__Access single OID value__: +**Access single OID value**: * An individual OID value can be retrieved via HTTP `GET` endpoint: `/monitoring/snmp?oid=` @@ -194,7 +194,7 @@ curl -X GET http://live-test.ravendb.net/monitoring/snmp?oid=1.3.6.1.4.1.45751.1 --- -__Access multiple OID values__: +**Access multiple OID values**: * Multiple OID values can be retrieved by making either a `GET` or a `POST` request to the following HTTP endpoint: `/monitoring/snmp/bulk` @@ -224,7 +224,7 @@ curl -X POST \ --- - __Get all OIDs:__ + **Get all OIDs:** * You can get a list of all OIDs along with their description via this HTTP `GET` endpoint: `/monitoring/snmp/oids` @@ -239,7 +239,7 @@ curl -X POST \ {NOTE: } -* RavenDB's **root OID** is: __1.3.6.1.4.1.45751.1.1.__ +* RavenDB's **root OID** is: **1.3.6.1.4.1.45751.1.1.** * Values represented by `X`, `D`, or `I` in the OIDs list below will be: * `X`: diff --git a/Documentation/6.0/Raven.Documentation.Pages/server/administration/SNMP/snmp.markdown b/Documentation/6.0/Raven.Documentation.Pages/server/administration/SNMP/snmp.markdown index 0496dbe1f7..e119e04cbf 100644 --- a/Documentation/6.0/Raven.Documentation.Pages/server/administration/SNMP/snmp.markdown +++ b/Documentation/6.0/Raven.Documentation.Pages/server/administration/SNMP/snmp.markdown @@ -49,7 +49,7 @@ SNMP support is available for [Enterprise](../../../start/licensing/licensing-ov {PANEL: Enabling SNMP in RavenDB} -* To monitor RavenDB using SNMP you __must__ first set the [Monitoring.Snmp.Enabled](../../../server/configuration/monitoring-configuration#monitoring.snmp.enabled) configuration key to _true_. +* To monitor RavenDB using SNMP you **must** first set the [Monitoring.Snmp.Enabled](../../../server/configuration/monitoring-configuration#monitoring.snmp.enabled) configuration key to _true_. * To learn how to modify a configuration key, refer to the [Configuration Overview](../../../server/configuration/configuration-options) article, which outlines all available options. @@ -111,7 +111,7 @@ There are several configurable SNMP properties in RavenDB: {INFO: } -* See article [Monitoring Options](../../../server/configuration/monitoring-configuration) for the full list of __SNMP configuration keys__. +* See article [Monitoring Options](../../../server/configuration/monitoring-configuration) for the full list of **SNMP configuration keys**. * To learn how to modify a configuration key, refer to the [Configuration Overview](../../../server/configuration/configuration-options) article, which outlines all available options. @@ -176,7 +176,7 @@ snmpget -v 3 -l authNoPriv -u ravendb -a SHA \ --- -__Access single OID value__: +**Access single OID value**: * An individual OID value can be retrieved via HTTP `GET` endpoint: `/monitoring/snmp?oid=` @@ -194,7 +194,7 @@ curl -X GET http://live-test.ravendb.net/monitoring/snmp?oid=1.3.6.1.4.1.45751.1 --- -__Access multiple OID values__: +**Access multiple OID values**: * Multiple OID values can be retrieved by making either a `GET` or a `POST` request to the following HTTP endpoint: `/monitoring/snmp/bulk` @@ -224,7 +224,7 @@ curl -X POST \ --- - __Get all OIDs:__ + **Get all OIDs:** * You can get a list of all OIDs along with their description via this HTTP `GET` endpoint: `/monitoring/snmp/oids` @@ -239,7 +239,7 @@ curl -X POST \ {NOTE: } -* RavenDB's **root OID** is: __1.3.6.1.4.1.45751.1.1.__ +* RavenDB's **root OID** is: **1.3.6.1.4.1.45751.1.1.** * Values represented by `X`, `D`, or `I` in the OIDs list below will be: * `X`: diff --git a/Documentation/6.0/Raven.Documentation.Pages/server/administration/monitoring/.docs.json b/Documentation/6.0/Raven.Documentation.Pages/server/administration/monitoring/.docs.json index 0ae25654a5..a3699c104c 100644 --- a/Documentation/6.0/Raven.Documentation.Pages/server/administration/monitoring/.docs.json +++ b/Documentation/6.0/Raven.Documentation.Pages/server/administration/monitoring/.docs.json @@ -1,14 +1,20 @@ [ - { - "Path": "telegraf.markdown", - "Name": "Telegraf Plugin", - "DiscussionId": "625d14af-842b-454e-967d-846214f43357", - "Mappings": [] - }, - { - "Path": "prometheus.markdown", - "Name": "Prometheus", - "DiscussionId": "01febf2d-8e60-4238-a227-cc706d036b14", - "Mappings": [] - } -] \ No newline at end of file + { + "Path": "telegraf.markdown", + "Name": "Telegraf Plugin", + "DiscussionId": "625d14af-842b-454e-967d-846214f43357", + "Mappings": [] + }, + { + "Path": "prometheus.markdown", + "Name": "Prometheus", + "DiscussionId": "01febf2d-8e60-4238-a227-cc706d036b14", + "Mappings": [] + }, + { + "Path": "mib-generation.markdown", + "Name": "MIB generation", + "DiscussionId": "01febf2d-8e60-4238-a227-cc706d036b14", + "Mappings": [] + } +] diff --git a/Documentation/6.0/Raven.Documentation.Pages/server/administration/monitoring/images/Prometheus_changed-index-priority.png b/Documentation/6.0/Raven.Documentation.Pages/server/administration/monitoring/images/Prometheus_changed-index-priority.png new file mode 100644 index 0000000000..874c8d45f7 Binary files /dev/null and b/Documentation/6.0/Raven.Documentation.Pages/server/administration/monitoring/images/Prometheus_changed-index-priority.png differ diff --git a/Documentation/6.0/Raven.Documentation.Pages/server/administration/monitoring/images/Prometheus_changed-index-priority.snagx b/Documentation/6.0/Raven.Documentation.Pages/server/administration/monitoring/images/Prometheus_changed-index-priority.snagx new file mode 100644 index 0000000000..05a9a88f18 Binary files /dev/null and b/Documentation/6.0/Raven.Documentation.Pages/server/administration/monitoring/images/Prometheus_changed-index-priority.snagx differ diff --git a/Documentation/6.0/Raven.Documentation.Pages/server/administration/monitoring/images/RavenDB_changed-index-priority.png b/Documentation/6.0/Raven.Documentation.Pages/server/administration/monitoring/images/RavenDB_changed-index-priority.png new file mode 100644 index 0000000000..0931009017 Binary files /dev/null and b/Documentation/6.0/Raven.Documentation.Pages/server/administration/monitoring/images/RavenDB_changed-index-priority.png differ diff --git a/Documentation/6.0/Raven.Documentation.Pages/server/administration/monitoring/images/RavenDB_changed-index-priority.snagx b/Documentation/6.0/Raven.Documentation.Pages/server/administration/monitoring/images/RavenDB_changed-index-priority.snagx new file mode 100644 index 0000000000..f3594cf78e Binary files /dev/null and b/Documentation/6.0/Raven.Documentation.Pages/server/administration/monitoring/images/RavenDB_changed-index-priority.snagx differ diff --git a/Documentation/6.0/Raven.Documentation.Pages/server/administration/monitoring/images/additional-info.png b/Documentation/6.0/Raven.Documentation.Pages/server/administration/monitoring/images/additional-info.png new file mode 100644 index 0000000000..a086236700 Binary files /dev/null and b/Documentation/6.0/Raven.Documentation.Pages/server/administration/monitoring/images/additional-info.png differ diff --git a/Documentation/6.0/Raven.Documentation.Pages/server/administration/monitoring/images/additional-info.snagx b/Documentation/6.0/Raven.Documentation.Pages/server/administration/monitoring/images/additional-info.snagx new file mode 100644 index 0000000000..1785512dd3 Binary files /dev/null and b/Documentation/6.0/Raven.Documentation.Pages/server/administration/monitoring/images/additional-info.snagx differ diff --git a/Documentation/6.0/Raven.Documentation.Pages/server/administration/monitoring/images/prometheus_metrics-graph.png b/Documentation/6.0/Raven.Documentation.Pages/server/administration/monitoring/images/prometheus_metrics-graph.png new file mode 100644 index 0000000000..e1b2007480 Binary files /dev/null and b/Documentation/6.0/Raven.Documentation.Pages/server/administration/monitoring/images/prometheus_metrics-graph.png differ diff --git a/Documentation/6.0/Raven.Documentation.Pages/server/administration/monitoring/images/prometheus_metrics-graph.snagx b/Documentation/6.0/Raven.Documentation.Pages/server/administration/monitoring/images/prometheus_metrics-graph.snagx new file mode 100644 index 0000000000..f06e825680 Binary files /dev/null and b/Documentation/6.0/Raven.Documentation.Pages/server/administration/monitoring/images/prometheus_metrics-graph.snagx differ diff --git a/Documentation/6.0/Raven.Documentation.Pages/server/administration/monitoring/images/prometheus_select-metrics.png b/Documentation/6.0/Raven.Documentation.Pages/server/administration/monitoring/images/prometheus_select-metrics.png new file mode 100644 index 0000000000..cc148dd818 Binary files /dev/null and b/Documentation/6.0/Raven.Documentation.Pages/server/administration/monitoring/images/prometheus_select-metrics.png differ diff --git a/Documentation/6.0/Raven.Documentation.Pages/server/administration/monitoring/images/prometheus_select-metrics.snagx b/Documentation/6.0/Raven.Documentation.Pages/server/administration/monitoring/images/prometheus_select-metrics.snagx new file mode 100644 index 0000000000..e28c5efc7e Binary files /dev/null and b/Documentation/6.0/Raven.Documentation.Pages/server/administration/monitoring/images/prometheus_select-metrics.snagx differ diff --git a/Documentation/6.0/Raven.Documentation.Pages/server/administration/monitoring/images/ravendb_prometheus-endpoint-output.png b/Documentation/6.0/Raven.Documentation.Pages/server/administration/monitoring/images/ravendb_prometheus-endpoint-output.png new file mode 100644 index 0000000000..3a64e8c2b9 Binary files /dev/null and b/Documentation/6.0/Raven.Documentation.Pages/server/administration/monitoring/images/ravendb_prometheus-endpoint-output.png differ diff --git a/Documentation/6.0/Raven.Documentation.Pages/server/administration/monitoring/images/ravendb_prometheus-endpoint-output.snagx b/Documentation/6.0/Raven.Documentation.Pages/server/administration/monitoring/images/ravendb_prometheus-endpoint-output.snagx new file mode 100644 index 0000000000..307106b592 Binary files /dev/null and b/Documentation/6.0/Raven.Documentation.Pages/server/administration/monitoring/images/ravendb_prometheus-endpoint-output.snagx differ diff --git a/Documentation/6.0/Raven.Documentation.Pages/server/administration/monitoring/mib-generation.markdown b/Documentation/6.0/Raven.Documentation.Pages/server/administration/monitoring/mib-generation.markdown new file mode 100644 index 0000000000..f38110b220 --- /dev/null +++ b/Documentation/6.0/Raven.Documentation.Pages/server/administration/monitoring/mib-generation.markdown @@ -0,0 +1,68 @@ +# Monitoring: MIB generation and usage + +--- + +{NOTE: } + +* RavenDB allows you to generate a MIB (Management Information Base) file that contains + a structured collection of SNMP OIDs. + +* The MIB can be generated through RavenDB's `/monitoring/snmp/mib` endpoint, + and fine-tuned using flags. + +* The created MIB can be used by monitoring tools to extract RavenDB metrics via SNMP. + +* In this page: + * [Generating a MIB](../../../server/administration/monitoring/mib-generation#generating-a-mib) + * [MIB generation endpoint](../../../server/administration/monitoring/mib-generation#mib-generation-endpoint) + * [Fine-tune the OIDs list](../../../server/administration/monitoring/mib-generation#fine-tune-the-oids-list) + +{NOTE/} + +--- + +{PANEL: Generating a MIB} + +### MIB generation endpoint + +To generate a MIB, use RavenDB's HTTP `/monitoring/snmp/mib` GET endpoint. +You can inspect this endpoint using your browser to download a text file with +RavenDB's OIDs, or connect it with a monitoring tool to utilize these OIDs. + +To use the endpoint, add its path to RavenDB's address (including RavenDB's port number). + +- To generate a MIB for RavenDB's live test server, for example. use: + [http://live-test.ravendb.net/monitoring/snmp/mib](http://live-test.ravendb.net/monitoring/snmp/mib) + +--- + +### Fine-tune the OIDs list + +By default, the generated MIB includes **server** metrics OIDs. You can fine-tune +it to include the OIDs range your are interested in. Available options are: + +* `includeServer` - Include or exclude OIDs with **server** metrics. +* `includeCluster` - Include or exclude OIDs with **cluster** metrics. +* `includeDatabases` - Include or exclude OIDs with **databases** metrics. + +#### Examples: +To include **databases** metrics OIDs, for example, you can use the `includeDatabases` flag this way: +[http://live-test.ravendb.net/monitoring/snmp/mib?includeDatabases=true](http://live-test.ravendb.net/monitoring/snmp/mib?includeDatabases=true) +Or to exclude **server** metrics OIDs use the **includeServer** flag like so: +[http://live-test.ravendb.net/monitoring/snmp/mib?includeServer=false](http://live-test.ravendb.net/monitoring/snmp/mib?includeServer=false) + +{PANEL/} + +## Related Articles + +### Monitoring +- [Prometheus](../../../server/administration/monitoring/prometheus) +- [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) diff --git a/Documentation/6.0/Samples/csharp/Raven.Documentation.Samples/Raven.Documentation.Samples.csproj b/Documentation/6.0/Samples/csharp/Raven.Documentation.Samples/Raven.Documentation.Samples.csproj index 48de3559bb..09837c9539 100644 --- a/Documentation/6.0/Samples/csharp/Raven.Documentation.Samples/Raven.Documentation.Samples.csproj +++ b/Documentation/6.0/Samples/csharp/Raven.Documentation.Samples/Raven.Documentation.Samples.csproj @@ -7,9 +7,9 @@ - - - + + + diff --git a/Documentation/6.2/Raven.Documentation.Pages/server/administration/monitoring/.docs.json b/Documentation/6.2/Raven.Documentation.Pages/server/administration/monitoring/.docs.json index eed051a872..7b4cd04f8b 100644 --- a/Documentation/6.2/Raven.Documentation.Pages/server/administration/monitoring/.docs.json +++ b/Documentation/6.2/Raven.Documentation.Pages/server/administration/monitoring/.docs.json @@ -1,20 +1,26 @@ [ - { - "Path": "telegraf.markdown", - "Name": "Telegraf Plugin", - "DiscussionId": "625d14af-842b-454e-967d-846214f43357", - "Mappings": [] - }, - { - "Path": "prometheus.markdown", - "Name": "Prometheus", - "DiscussionId": "01febf2d-8e60-4238-a227-cc706d036b14", - "Mappings": [] - }, - { - "Path": "open-telemetry.markdown", - "Name": "OpenTelemetry", - "DiscussionId": "a38d5253-cb11-4e46-8942-8c694c23ffd4", - "Mappings": [] - } -] \ No newline at end of file + { + "Path": "telegraf.markdown", + "Name": "Telegraf Plugin", + "DiscussionId": "625d14af-842b-454e-967d-846214f43357", + "Mappings": [] + }, + { + "Path": "prometheus.markdown", + "Name": "Prometheus", + "DiscussionId": "01febf2d-8e60-4238-a227-cc706d036b14", + "Mappings": [] + }, + { + "Path": "open-telemetry.markdown", + "Name": "OpenTelemetry", + "DiscussionId": "a38d5253-cb11-4e46-8942-8c694c23ffd4", + "Mappings": [] + }, + { + "Path": "mib-generation.markdown", + "Name": "MIB generation", + "DiscussionId": "01febf2d-8e60-4238-a227-cc706d036b14", + "Mappings": [] + } +] diff --git a/Documentation/7.0/Raven.Documentation.Pages/server/administration/SNMP/snmp.markdown b/Documentation/7.0/Raven.Documentation.Pages/server/administration/SNMP/snmp.markdown index 1281640d5b..d6d2081bca 100644 --- a/Documentation/7.0/Raven.Documentation.Pages/server/administration/SNMP/snmp.markdown +++ b/Documentation/7.0/Raven.Documentation.Pages/server/administration/SNMP/snmp.markdown @@ -55,7 +55,7 @@ SNMP support is available for [Enterprise](../../../start/licensing/licensing-ov {PANEL: Enabling SNMP in RavenDB} -* To monitor RavenDB using SNMP you __must__ first set the [Monitoring.Snmp.Enabled](../../../server/configuration/monitoring-configuration#monitoring.snmp.enabled) configuration key to _true_. +* To monitor RavenDB using SNMP you **must** first set the [Monitoring.Snmp.Enabled](../../../server/configuration/monitoring-configuration#monitoring.snmp.enabled) configuration key to _true_. * To learn how to modify a configuration key, refer to the [Configuration Overview](../../../server/configuration/configuration-options) article, which outlines all available options. @@ -117,7 +117,7 @@ There are several configurable SNMP properties in RavenDB: {INFO: } -* See article [Monitoring Options](../../../server/configuration/monitoring-configuration) for the full list of __SNMP configuration keys__. +* See article [Monitoring Options](../../../server/configuration/monitoring-configuration) for the full list of **SNMP configuration keys**. * To learn how to modify a configuration key, refer to the [Configuration Overview](../../../server/configuration/configuration-options) article, which outlines all available options. @@ -182,7 +182,7 @@ snmpget -v 3 -l authNoPriv -u ravendb -a SHA \ --- -__Access single OID value__: +**Access single OID value**: * An individual OID value can be retrieved via HTTP `GET` endpoint: `/monitoring/snmp?oid=` @@ -200,7 +200,7 @@ curl -X GET http://live-test.ravendb.net/monitoring/snmp?oid=1.3.6.1.4.1.45751.1 --- -__Access multiple OID values__: +**Access multiple OID values**: * Multiple OID values can be retrieved by making either a `GET` or a `POST` request to the following HTTP endpoint: `/monitoring/snmp/bulk` @@ -230,7 +230,7 @@ curl -X POST \ --- - __Get all OIDs:__ + **Get all OIDs:** * You can get a list of all OIDs along with their description via this HTTP `GET` endpoint: `/monitoring/snmp/oids` @@ -245,7 +245,7 @@ curl -X POST \ {NOTE: } -* RavenDB's **root OID** is: __1.3.6.1.4.1.45751.1.1.__ +* RavenDB's **root OID** is: **1.3.6.1.4.1.45751.1.1.** * Values represented by `X`, `D`, or `I` in the OIDs list below will be: * `X`: diff --git a/Documentation/7.0/Raven.Documentation.Pages/server/administration/monitoring/.docs.json b/Documentation/7.0/Raven.Documentation.Pages/server/administration/monitoring/.docs.json index eed051a872..7b4cd04f8b 100644 --- a/Documentation/7.0/Raven.Documentation.Pages/server/administration/monitoring/.docs.json +++ b/Documentation/7.0/Raven.Documentation.Pages/server/administration/monitoring/.docs.json @@ -1,20 +1,26 @@ [ - { - "Path": "telegraf.markdown", - "Name": "Telegraf Plugin", - "DiscussionId": "625d14af-842b-454e-967d-846214f43357", - "Mappings": [] - }, - { - "Path": "prometheus.markdown", - "Name": "Prometheus", - "DiscussionId": "01febf2d-8e60-4238-a227-cc706d036b14", - "Mappings": [] - }, - { - "Path": "open-telemetry.markdown", - "Name": "OpenTelemetry", - "DiscussionId": "a38d5253-cb11-4e46-8942-8c694c23ffd4", - "Mappings": [] - } -] \ No newline at end of file + { + "Path": "telegraf.markdown", + "Name": "Telegraf Plugin", + "DiscussionId": "625d14af-842b-454e-967d-846214f43357", + "Mappings": [] + }, + { + "Path": "prometheus.markdown", + "Name": "Prometheus", + "DiscussionId": "01febf2d-8e60-4238-a227-cc706d036b14", + "Mappings": [] + }, + { + "Path": "open-telemetry.markdown", + "Name": "OpenTelemetry", + "DiscussionId": "a38d5253-cb11-4e46-8942-8c694c23ffd4", + "Mappings": [] + }, + { + "Path": "mib-generation.markdown", + "Name": "MIB generation", + "DiscussionId": "01febf2d-8e60-4238-a227-cc706d036b14", + "Mappings": [] + } +]