You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: README.md
+9-3
Original file line number
Diff line number
Diff line change
@@ -22,7 +22,9 @@ First, install the package:
22
22
pip install codecovopentelem
23
23
```
24
24
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:
26
28
27
29
```python
28
30
from opentelemetry.sdk.trace import TracerProvider
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
74
76
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.
76
78
77
79
Note that these examples demonstrate _possible_ ways to incorporate this package into your project. As always, your specific needs may vary.
Note that this example also demonstrates how to integrate using a `try/except`.
134
136
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
+
135
141
## Configuration
136
142
137
143
-`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