Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/digma-ai/otel-sample-fastapi
Simple FastAPI example with OpenTelemetry and Digma instrumentation
https://github.com/digma-ai/otel-sample-fastapi
fastapi observability opentelemetry python
Last synced: about 1 month ago
JSON representation
Simple FastAPI example with OpenTelemetry and Digma instrumentation
- Host: GitHub
- URL: https://github.com/digma-ai/otel-sample-fastapi
- Owner: digma-ai
- Created: 2022-04-25T01:18:58.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2022-11-29T07:47:10.000Z (about 2 years ago)
- Last Synced: 2023-03-03T19:59:40.068Z (almost 2 years ago)
- Topics: fastapi, observability, opentelemetry, python
- Language: Python
- Homepage:
- Size: 32.2 KB
- Stars: 0
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# OpenTelemetry Sample: FastAPI simple API instrumented with OTEL and Digma
The following code is a sample application used to test various scenarios, performance bottlenecks and runtime errors with [Digma](https://github.com/digma-ai/digma). This sample uses the standard OTEL instrumentation library as well as the [Digma instrumentation](https://github.com/digma-ai/opentelemetry-instrumentation-digma) helper library.
## Preqrequisites
- [Python 3.8+](https://www.python.org/downloads/)
- [vsCode](https://code.visualstudio.com/download)
## Running the app with Digma
### Install the IDE extension
1. Install the [Digma Extension](https://marketplace.visualstudio.com/items?itemName=digma.digma) into the vsCode IDE
2. Open the 'Settings' tab of the extension
3. Set the 'Digma URL' to your Digma Account URL on the User/Workspace level, leave the port as 5051.
### Prepare the FastAPI app environment
1. Clone the repo and switch to the repo folder.
2. Optionally create and activate a virtualenv for the project, for example:
```bash
python3 -m venv ./venv
source venv/bin/activate
```
3. Install all dependencies:
```bash
pip install -r requirements.txt
```
4. In main.py, modify the OTEL exporter to use the Digma backend as well. For the 'backend_url' parameter in the Digma instrumentation (line 33) replace 'localhost' with the URL provided to your account, like so (do not include any brackets in the URL):
```python
digma_opentelemetry_boostrap(service_name='server-ms', digma_backend="http://[ACCOUNT_URL]:5050",
configuration=DigmaConfiguration().trace_this_package()
.set_environment('dev'))
```
4. Run the main file.
```bash
python main.py
```
### Use the application
Play around to trigger some API calls. You can try visiting some of the API urls.
For example:
- http://localhost:8000
- http://localhost:8000/login
- http://localhost:8000/validate
- http://localhost:8000/process
- http://localhost:8000/validateuser/2
### Troubleshooting
If you've encountered any issue, open the 'output' panel for the digma extension, it may contain more information about the issue:
