Add excluded_urls to asgi instrumentation docs #2407
Conversation
...tation/opentelemetry-instrumentation-asgi/src/opentelemetry/instrumentation/asgi/__init__.py
Outdated
Show resolved
Hide resolved
andy-edvalson
changed the title
Add missing docs for other constructor params
andy-edvalson
force-pushed
the
add-excluded-urls-docs
branch
from
03d2ad5 to
e9ad6c6
Compare
...tation/opentelemetry-instrumentation-asgi/src/opentelemetry/instrumentation/asgi/__init__.py
Outdated
Show resolved
Hide resolved
|
@andy-edvalson please fix |
Sorry just getting back to this. I didn't have access to a machine I could install the extra pieces on to test it |
| @@ -449,24 +450,34 @@ class OpenTelemetryMiddleware: | |||
|
|
|||
| Args: | |||
| app: The ASGI application callable to forward requests to. | |||
| excluded_urls: Optional parameter to specify URLs that should be excluded from tracing. | |||
| This can be useful for skipping health checks or other endpoints that do not need to be monitored. | |||
| Should be an instance of :class:`opentelemetry.util.http.ExcludeList`. Defaults to None. | |||
There was a problem hiding this comment.
I think sphinx forces you to add the automodule for the http utils because of this reference here. I think there are some apis here that we are okay with exposing so adding a docs section for the utils should be no issue.
|
Thanks for the pr! Would you be able to add a section in the configuration docstrings to show the usage? Just like what we have for requests |
Yeah I can do that but I won't be able to get back to this for a few days |
Description
Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.
Fixes # (issue)
Type of change
This is purely a documentation update
How Has This Been Tested?
We ran into a need to filter health checks out of our ASGI application's telemetry. I found that the filtering was already supported but not present in the docs.
Does This PR Require a Core Repo Change?
No
Checklist:
See contributing.md for styleguide, changelog guidelines, and more.