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.

Sign up for GitHub

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

feat: restructuring apm docs #829

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

feat: restructuring apm docs #829

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 22 additions & 4 deletions data/docs/instrumentation/flask.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,23 +3,29 @@ date: 2024-06-06
id: flask
title: Flask OpenTelemetry Instrumentation
description: Instrument your Flask application with OpenTelemetry and send data to SigNoz

hide_table_of_contents: true
---



import InstrumentationFAQ from '@/components/shared/instrumentation-faq.md'


This document contains instructions on how to set up OpenTelemetry instrumentation in your Flask applications. OpenTelemetry, also known as OTel for short, is an open source observability framework that can help you generate and collect telemetry data - traces, metrics, and logs from your Flask application.
This document contains instructions on how to set up OpenTelemetry instrumentation in your Flask applications.
OpenTelemetry, also known as OTel for short, is an open source observability framework that can help you generate and collect telemetry data - traces, metrics,
and logs from your Flask application.

<Tabs>

<TabItem value="cloud" label="Cloud" default>

## Requirements

- Python 3.8 or newer

## Send Traces to SigNoz Cloud

<YouTube id="50t8T2iL6sA" mute={false} />
{/* <YouTube id="50t8T2iL6sA" mute={false} /> */}

Based on your application environment, you can choose the setup below to send traces to SigNoz Cloud.

Expand Down Expand Up @@ -262,6 +268,14 @@ In case you encounter an issue where all applications do not get listed in the s
</TabItem>
</Tabs>

</TabItem>

<TabItem value="self-host" label="Self-Host" default>

## Requirements

- Python 3.8 or newer

## Send Traces to Self-Hosted SigNoz

There are three major steps to using OpenTelemetry:
Expand Down Expand Up @@ -373,6 +387,10 @@ You might see other dummy applications if you’re using SigNoz for the first ti
</figure>


</TabItem>

</Tabs>

## Database Instrumentation

Make sure that the DB client library you are using has the corresponding instrumentation library, and the version of the DB client library is supported by OpenTelemetry.
Expand Down Expand Up @@ -479,4 +497,4 @@ Ensure you have the correct opentelemetry instrumentations:

- We have included a sample Flask application with README.md at [Sample Flask App Github Repo.](https://github.com/SigNoz/sample-flask-app)

<InstrumentationFAQ />
{/* <InstrumentationFAQ /> */}