Skip to content

Commit 6e8ebd2

Browse files
authored
Merge pull request #1999 from hiddenshadow21/RDoc-3169
RDoc-3169 Add Cloud OpenTelemetry feature description
2 parents f2a56ad + 36adc7e commit 6e8ebd2

File tree

5 files changed

+40
-7
lines changed

5 files changed

+40
-7
lines changed

Documentation/4.2/Raven.Documentation.Pages/cloud/cloud-features.markdown

Lines changed: 40 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -87,17 +87,38 @@ This feature is available only for *RavenDB* **6.0 and newer**.
8787

8888
{PANEL: Monitoring }
8989

90-
*RavenDB Cloud* allows you to monitor your *RavenDB Cloud* instances via *SNMP* protocol. *SNMP* is a widely used
91-
network
92-
management protocol that allows for the collection and organization of information about managed devices on IP networks.
90+
*RavenDB Cloud* allows you to monitor your *RavenDB Cloud* instances via *SNMP* and *OpenTelemetry* protocols.
91+
92+
*SNMP* is a widely used
93+
network management protocol that allows for the collection and organization of information about managed devices on IP
94+
networks.
95+
*RavenDB Cloud* leverages the *OpenTelemetry SDK* to send metrics data via the *OpenTelemetry* Protocol, allowing
96+
seamless
97+
data collection and analysis by an OpenTelemetry retriever.
9398

9499
## Configuration
95100

96-
Click **Configure** Button in *Monitoring* feature row in order to configure this feature.
97-
You will see Monitoring Configuration View. You can edit SNMP Monitoring IPs in the first section.
98-
The second section displays SNMPv3 Monitoring credentials.
101+
Click the **Configure** button in the *Monitoring* feature row to configure this feature.
102+
You will be taken to the *Monitoring Configuration View*, which is divided into two tabs:
103+
104+
1. SNMP Configuration Tab:
105+
106+
- In the first section, you can edit SNMP Monitoring IPs.
107+
108+
- In the second section, you can view and update SNMPv3 Monitoring credentials.
109+
110+
2. OpenTelemetry Configuration Tab:
99111

100-
!["Monitoring Configuration View"](images/product-features-monitoring-configuration.png "Monitoring Configuration View")
112+
- Select which Meters should be collected.
113+
114+
- Specify where these Meters should be sent.
115+
116+
!["Monitoring Configuration View SNMP"](images/product-features-monitoring-configuration.png "Monitoring Configuration View SNMP")
117+
!["Monitoring Configuration View OpenTelemetry"](images/product-features-monitoring-configuration-opentelemetry.png "Monitoring Configuration View OpenTelemetry")
118+
119+
{INFO: Availability }
120+
OpenTelemetry feature is available only for *RavenDB* **6.2 and newer**.
121+
{INFO/}
101122

102123
### SNMP Monitoring IPs
103124

@@ -128,6 +149,18 @@ are [CIDR ranges](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing#C
128149
that define networks from which the connection is allowed.
129150
{INFO/}
130151

152+
### OpenTelemetry Configuration
153+
154+
{WARNING: Product Restart }
155+
Your product will be restarted automatically (node by node) to apply settings needed for feature to work properly.
156+
{WARNING/}
157+
158+
This section allows you to select meters and specify where these should be sent using the *OpenTelemetry* protocol.
159+
160+
You can read step by step OpenTelemetry & Grafana configuration [here](https://ravendb.net/articles/grafana-cloud-configuration-with-opentelemetry).
161+
162+
!["Edit OpenTelemetry"](images/product-features-monitoring-edit-opentelemetry.png "Edit OpenTelemetry")
163+
131164
{PANEL/}
132165

133166
{PANEL: Autoscaling }

0 commit comments

Comments
 (0)