{"id":18976309,"url":"https://github.com/quickwit-oss/tutorials","last_synced_at":"2025-06-12T17:08:10.952Z","repository":{"id":66218194,"uuid":"596175678","full_name":"quickwit-oss/tutorials","owner":"quickwit-oss","description":null,"archived":false,"fork":false,"pushed_at":"2024-01-21T23:35:58.000Z","size":44,"stargazers_count":4,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-03-25T21:06:53.631Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/quickwit-oss.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2023-02-01T16:18:37.000Z","updated_at":"2024-01-22T18:29:49.000Z","dependencies_parsed_at":"2024-01-22T00:34:38.352Z","dependency_job_id":"63f5c4b9-c989-420b-8891-a4a063b1e43a","html_url":"https://github.com/quickwit-oss/tutorials","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/quickwit-oss%2Ftutorials","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/quickwit-oss%2Ftutorials/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/quickwit-oss%2Ftutorials/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/quickwit-oss%2Ftutorials/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/quickwit-oss","download_url":"https://codeload.github.com/quickwit-oss/tutorials/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":223706367,"owners_count":17189330,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-08T15:23:31.133Z","updated_at":"2024-11-08T15:23:33.071Z","avatar_url":"https://github.com/quickwit-oss.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Tutorials\n\n## Tracing\n\n### Setup\n\n1. Clone the repository and go to the tracing directory\n\n2. Create a virtual environment\n\n```bash\npython3 -m venv . \u0026\u0026 source ./bin/activate\n```\n\n3. Install python dependencies\n\n```bash\npip install flask\n# Installs the API, SDK, and the opentelemetry-bootstrap and opentelemetry-instrument tools\npip install opentelemetry-distro \n# Tool for automatic instrumentation.\nopentelemetry-bootstrap -a install\n```\n\n4. Install Quickwit and start a server\n\n```bash\ncurl -L https://install.quickwit.io | sh\ncd quickwit-*\n./quickwit run\n```\n\n### Auto-instrumentation\n\nStart your app with `my_instrumented_app` script.\n\n```bash\nOTEL_METRICS_EXPORTER=none \\ # We don't need metrics\nOTEL_SERVICE_NAME=my_app \\\nOTEL_EXPORTER_OTLP_TRACES_ENDPOINT=http://localhost:7281 \\\nopentelemetry-instrument python my_instrumented_app.py\n```\n\nNow hit the endpoint [`http://localhost:5000/process-ip`](http://localhost:5000/process-ip), it will send traces to Quickwit.\n\n### Manual instrumentation\n\nStart your app with `my_manually_instrumented_app` script.\n\n```bash\npython my_manually_instrumented_app.py\n```\n\nNow hit the endpoint [`http://localhost:5000/process-ip`](http://localhost:5000/process-ip), it will send traces to Quickwit.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fquickwit-oss%2Ftutorials","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fquickwit-oss%2Ftutorials","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fquickwit-oss%2Ftutorials/lists"}