Skip to content

Commit dec00eb

Browse files
vmihailencozach-iee
authored andcommitted
chore(documentation): fix redirects and some small cleanups (redis#2801)
1 parent 1a27e4d commit dec00eb

File tree

1 file changed

+34
-39
lines changed

1 file changed

+34
-39
lines changed

docs/opentelemetry.rst

Lines changed: 34 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Integrating OpenTelemetry
44
What is OpenTelemetry?
55
----------------------
66

7-
`OpenTelemetry <https://opentelemetry.io>`_ is an open-source observability framework for traces, metrics, and logs.
7+
`OpenTelemetry <https://opentelemetry.io>`_ is an open-source observability framework for traces, metrics, and logs. It is a merger of OpenCensus and OpenTracing projects hosted by Cloud Native Computing Foundation.
88

99
OpenTelemetry allows developers to collect and export telemetry data in a vendor agnostic way. With OpenTelemetry, you can instrument your application once and then add or change vendors without changing the instrumentation, for example, here is a list of `popular DataDog competitors <https://uptrace.dev/get/compare/datadog-competitors.html>`_ that support OpenTelemetry.
1010

@@ -97,7 +97,7 @@ See `OpenTelemetry Python Tracing API <https://uptrace.dev/opentelemetry/python-
9797
Uptrace
9898
-------
9999

100-
Uptrace is an `open-source APM <https://uptrace.dev/get/open-source-apm.html>`_ that supports distributed tracing, metrics, and logs. You can use it to monitor applications and set up automatic alerts to receive notifications via email, Slack, Telegram, and more.
100+
Uptrace is an `open source APM <https://uptrace.dev/get/open-source-apm.html>`_ that supports distributed tracing, metrics, and logs. You can use it to monitor applications and set up automatic alerts to receive notifications via email, Slack, Telegram, and more.
101101

102102
You can use Uptrace to monitor redis-py using this `GitHub example <https://github.com/redis/redis-py/tree/master/docs/examples/opentelemetry>`_ as a starting point.
103103

@@ -111,9 +111,9 @@ Monitoring Redis Server performance
111111

112112
In addition to monitoring redis-py client, you can also monitor Redis Server performance using OpenTelemetry Collector Agent.
113113

114-
OpenTelemetry Collector is a proxy/middleman between your application and a `distributed tracing tool <https://uptrace.dev/get/compare/distributed-tracing-tools.html>`_ such as Uptrace or Jaeger. Collector receives telemetry data, processes it, and then exports the data to APM tools that can store it permanently.
114+
OpenTelemetry Collector is a proxy/middleman between your application and a `distributed tracing tool <https://uptrace.dev/blog/distributed-tracing-tools.html>`_ such as Uptrace or Jaeger. Collector receives telemetry data, processes it, and then exports the data to APM tools that can store it permanently.
115115

116-
For example, you can use the Redis receiver provided by Otel Collector to `monitor Redis performance <https://uptrace.dev/opentelemetry/redis-monitoring.html>`_:
116+
For example, you can use the `OpenTelemetry Redis receiver <https://uptrace.dev/get/monitor/opentelemetry-redis.html>` provided by Otel Collector to monitor Redis performance:
117117

118118
.. image:: images/opentelemetry/redis-metrics.png
119119
:alt: Redis metrics
@@ -123,55 +123,50 @@ See introduction to `OpenTelemetry Collector <https://uptrace.dev/opentelemetry/
123123
Alerting and notifications
124124
--------------------------
125125

126-
Uptrace also allows you to monitor `OpenTelemetry metrics <https://uptrace.dev/opentelemetry/metrics.html>`_ using alerting rules. For example, the following rule uses the group by node expression to create an alert whenever an individual Redis shard is down:
126+
Uptrace also allows you to monitor `OpenTelemetry metrics <https://uptrace.dev/opentelemetry/metrics.html>`_ using alerting rules. For example, the following monitor uses the group by node expression to create an alert whenever an individual Redis shard is down:
127127

128128
.. code-block:: python
129129
130-
# /etc/uptrace/uptrace.yml
131-
132-
alerting:
133-
rules:
134-
- name: Redis shard is down
135-
metrics:
136-
- redis_up as $redis_up
137-
query:
138-
- group by cluster # monitor each cluster,
139-
- group by bdb # each database,
140-
- group by node # and each shard
141-
- $redis_up == 0
142-
# shard should be down for 5 minutes to trigger an alert
143-
for: 5m
130+
monitors:
131+
- name: Redis shard is down
132+
metrics:
133+
- redis_up as $redis_up
134+
query:
135+
- group by cluster # monitor each cluster,
136+
- group by bdb # each database,
137+
- group by node # and each shard
138+
- $redis_up
139+
min_allowed_value: 1
140+
# shard should be down for 5 minutes to trigger an alert
141+
for_duration: 5m
144142
145143
You can also create queries with more complex expressions. For example, the following rule creates an alert when the keyspace hit rate is lower than 75%:
146144

147145
.. code-block:: python
148146
149-
# /etc/uptrace/uptrace.yml
150-
151-
alerting:
152-
rules:
153-
- name: Redis read hit rate < 75%
154-
metrics:
155-
- redis_keyspace_read_hits as $hits
156-
- redis_keyspace_read_misses as $misses
157-
query:
158-
- group by cluster
159-
- group by bdb
160-
- group by node
161-
- $hits / ($hits + $misses) < 0.75
162-
for: 5m
147+
monitors:
148+
- name: Redis read hit rate < 75%
149+
metrics:
150+
- redis_keyspace_read_hits as $hits
151+
- redis_keyspace_read_misses as $misses
152+
query:
153+
- group by cluster
154+
- group by bdb
155+
- group by node
156+
- $hits / ($hits + $misses) as hit_rate
157+
min_allowed_value: 0.75
158+
for_duration: 5m
163159
164160
See `Alerting and Notifications <https://uptrace.dev/get/alerting.html>`_ for details.
165161

166162
What's next?
167163
------------
168164

169-
Next, you can learn how to configure `uptrace-python <https://uptrace.dev/get/uptrace-python.html>`_ to export spans, metrics, and logs to Uptrace.
165+
Next, you can learn how to configure `uptrace-python <https://uptrace.dev/get/opentelemetry-python.html>`_ to export spans, metrics, and logs to Uptrace.
170166

171167
You may also be interested in the following guides:
172168

173-
- `OpenTelemetry Django <https://uptrace.dev/opentelemetry/instrumentations/python-django.html>`_
174-
- `OpenTelemetry Flask <https://uptrace.dev/opentelemetry/instrumentations/python-flask.html>`_
175-
- `OpenTelemetry FastAPI <https://uptrace.dev/opentelemetry/instrumentations/python-fastapi.html>`_
176-
- `OpenTelemetry SQLAlchemy <https://uptrace.dev/opentelemetry/instrumentations/python-sqlalchemy.html>`_
177-
- `OpenTelemetry instrumentations <https://uptrace.dev/opentelemetry/instrumentations/>`_
169+
- `OpenTelemetry Django <https://uptrace.dev/get/instrument/opentelemetry-django.html>`_
170+
- `OpenTelemetry Flask <https://uptrace.dev/get/instrument/instrument/opentelemetry-flask.html>`_
171+
- `OpenTelemetry FastAPI <https://uptrace.dev/get/instrument/opentelemetry-fastapi.html>`_
172+
- `OpenTelemetry SQLAlchemy <https://uptrace.dev/get/instrument/opentelemetry-sqlalchemy.html>`_

0 commit comments

Comments
 (0)