Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add OpenTelemetry example with Uptrace backend #2452

Merged
merged 8 commits into from Dec 14, 2022

Conversation

vmihailenco
Copy link
Contributor

This PR adds some docs that explain how start monitoring redis-py performance using OpenTelemetry and Uptrace. Here is how the doc page will look like.

I've briefly discussed this on Slack with @chayim and he encouraged me to open a PR to start a discussion. So here I am :)

@codecov-commenter
Copy link

codecov-commenter commented Nov 11, 2022

Codecov Report

Base: 92.21% // Head: 92.21% // Decreases project coverage by -0.00% ⚠️

Coverage data is based on head (3f11358) compared to base (3a121be).
Patch coverage: 77.14% of modified lines in pull request are covered.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #2452      +/-   ##
==========================================
- Coverage   92.21%   92.21%   -0.01%     
==========================================
  Files         113      113              
  Lines       29337    29347      +10     
==========================================
+ Hits        27053    27062       +9     
- Misses       2284     2285       +1     
Impacted Files Coverage Δ
redis/asyncio/client.py 92.51% <ø> (ø)
redis/client.py 89.19% <ø> (ø)
redis/commands/graph/node.py 97.77% <ø> (ø)
redis/commands/search/commands.py 84.61% <0.00%> (ø)
tests/conftest.py 84.94% <ø> (-0.78%) ⬇️
tests/test_asyncio/test_cluster.py 97.48% <0.00%> (-0.13%) ⬇️
tests/test_asyncio/test_commands.py 98.35% <ø> (ø)
tests/test_asyncio/test_connection_pool.py 99.40% <ø> (ø)
tests/test_asyncio/test_pipeline.py 100.00% <ø> (ø)
tests/test_asyncio/test_pubsub.py 99.37% <ø> (-0.16%) ⬇️
... and 15 more

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

@chayim chayim added the maintenance Maintenance (CI, Releases, etc) label Nov 15, 2022
@chayim
Copy link
Contributor

chayim commented Nov 15, 2022

@vmihailenco I think we should probably move these things from the docker folder (to start) into docs/examples. Perhaps even start a subsection on monitoring. WDYT?

docs/opentelemetry.rst Outdated Show resolved Hide resolved
docs/opentelemetry.rst Outdated Show resolved Hide resolved
docs/opentelemetry.rst Outdated Show resolved Hide resolved
@vmihailenco
Copy link
Contributor Author

I think we should probably move these things from the docker folder (to start) into docs/examples. Perhaps even start a subsection on monitoring. WDYT?

A subsection is probably too much to start with, but I will move everything to docs/examples 👍

@vmihailenco
Copy link
Contributor Author

vmihailenco commented Nov 15, 2022

Perhaps even start a subsection on monitoring

Sorry, I misread subsection as subfolder. I guess you mean a section in examples.rst? I will play with it.

@vmihailenco
Copy link
Contributor Author

@chayim PTAL. All should be fixed, but I was not able to update examples.rst in a meaningful manner. Perhaps you could show me an example?

@vmihailenco
Copy link
Contributor Author

The CI failure seems unrelated...

@vmihailenco
Copy link
Contributor Author

@chayim I've added the Jupyter notebook we've discussed and updated the title. PTAL

@dvora-h dvora-h merged commit 74c251a into redis:master Dec 14, 2022
@vmihailenco
Copy link
Contributor Author

@dvora-h thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
maintenance Maintenance (CI, Releases, etc)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants