Skip to content

Commit 46518b7

Browse files
committed
Update README
1 parent 64f0921 commit 46518b7

File tree

1 file changed

+9
-3
lines changed

1 file changed

+9
-3
lines changed

README.md

+9-3
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,9 @@ First, install the package:
2222
pip install codecovopentelem
2323
```
2424

25-
Second, include the following snippet in your application. Where this is snippet is placed varies depending on the application, but should generally be placed wherever you would put your application's OpenTelemetry startup code. In lieu of that, this code should be incorporated in such a way that it is part of your application's startup process:
25+
Second, include the following snippet in your application. Where this is snippet is placed varies depending on the application, see _Integration Examples_ below.
26+
27+
The snippet:
2628

2729
```python
2830
from opentelemetry.sdk.trace import TracerProvider
@@ -70,9 +72,9 @@ provider.add_span_processor(generator)
7072
provider.add_span_processor(BatchSpanProcessor(exporter))
7173
```
7274

73-
You can see the Framework Specific Integration Examples section below for framework specific examples of how to incorporate this snippet into your project.
75+
### Integration Examples
7476

75-
### Framework Specific Integration Examples
77+
The specifics of how this library is integrated into your project depends on the project itself. This section contains a few common, framework specific, integration approaches along with the general integration approach at the end.
7678

7779
Note that these examples demonstrate _possible_ ways to incorporate this package into your project. As always, your specific needs may vary.
7880

@@ -132,6 +134,10 @@ application = get_wsgi_application()
132134

133135
Note that this example also demonstrates how to integrate using a `try/except`.
134136

137+
#### General Integration
138+
139+
If you are not using Django or Flask integration is still possible using the above code snippet. How to do this may vary greatly depending on your use case. In general, though, the code snippet should be placed wherever you would put your application's OpenTelemetry startup code. In lieu of that, this code should be incorporated in such a way that it is part of your application's startup process.
140+
135141
## Configuration
136142

137143
- `code` -- A unique identifier for the current deployment across all environments where it may be deployed. Conventionally, this is a combination of version number and environment name, but can be anything as long as it is unique in each environment for the version being deployed.

0 commit comments

Comments
 (0)