Add rolldice reference application (FastAPI) by reggied · Pull Request #5244 · open-telemetry/opentelemetry-python

reggied · 2026-05-21T16:15:09Z

Description

Implements the OpenTelemetry reference application specification [1] with both uninstrumented and instrumented versions of a FastAPI dice-rolling service. The instrumented version uses declarative (file-based) YAML configuration for the telemetry pipeline with OTLP HTTP and console exporters for all three signal types (traces, metrics, logs).

[1] https://opentelemetry.io/docs/getting-started/reference-application-specification/

Fixes # #5167

Type of change

Please delete options that are not relevant.

New feature (non-breaking change which adds functionality)

How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration

Test A

Does This PR Require a Contrib Repo Change?

Yes. - Link to PR:
No.

Checklist:

Followed the style guidelines of this project
Changelogs have been updated
Unit tests have been added
Documentation has been updated

linux-foundation-easycla · 2026-05-21T16:15:20Z

The committers listed above are authorized under a signed CLA.

✅ login: reggied / name: Reggie Dugard (2b97f1e, d871490, 4392aa3)

Implements the OpenTelemetry reference application specification [1] with both uninstrumented and instrumented versions of a FastAPI dice-rolling service. The instrumented version uses declarative (file-based) YAML configuration for the telemetry pipeline with OTLP HTTP and console exporters for all three signal types (traces, metrics, logs). [1] https://opentelemetry.io/docs/getting-started/reference-application-specification/ Assisted-by: Claude Opus 4.6

Add OS resource detector, OTEL_LOG_LEVEL diagnostic verbosity control, dynamic OTEL_SERVICE_NAME support via env var substitution, and a CI workflow that smoke-tests both the instrumented and uninstrumented variants of the rolldice application. Co-Authored-By: Claude Opus 4.6 (1M context)

Update all license headers to the SPDX two-line format, fix import sorting and formatting per ruff, and add a towncrier changelog fragment.

reggied · 2026-06-08T20:38:00Z

@MikeGoldsmith , could you take a look at this when you get a chance?

tammy-baylis-swi · 2026-06-11T16:07:30Z

Thank you for this @reggied ! Have we considered putting it in docs/examples instead? https://github.com/open-telemetry/opentelemetry-python/tree/main/docs/examples

reggied · 2026-06-11T21:13:56Z

Thank you for this @reggied ! Have we considered putting it in docs/examples instead? https://github.com/open-telemetry/opentelemetry-python/tree/main/docs/examples

Hi @tammy-baylis-swi ! I'm new to this repo, so the current location was a best guess. I didn't put it in docs/examples because the modules in there seemed like simple one-file examples whereas this is an entire example application, but if you think that is more appropriate, I can move it. How would you name it?

tammy-baylis-swi · 2026-06-15T18:32:00Z

Hi @tammy-baylis-swi ! I'm new to this repo, so the current location was a best guess. I didn't put it in docs/examples because the modules in there seemed like simple one-file examples whereas this is an entire example application, but if you think that is more appropriate, I can move it. How would you name it?

Nice, welcome 👋

I suggest docs/examples/fastapi-rolldice to align with existing docs/examples/django, and so it will link from https://opentelemetry-python.readthedocs.io/en/stable/examples/ via https://opentelemetry.io/docs/languages/python/. This is definitely a more substantial example than the Django one but I think it's a better fit than say the FastAPI instrumentor source code

github-actions · 2026-06-30T04:39:03Z

This PR has been automatically marked as stale because it has not had any activity for 14 days. It will be closed if no further activity occurs within 14 days of this comment.
If you're still working on this, please add a comment or push new commits.

In response reviewer feedback, move theI roll dice reference app to the docs/examples.

reggied · 2026-07-04T14:35:01Z

@tammy-baylis-swi , I've moved the reference app as you suggested, please take a look when you can. Thanks!

emdneto

Thanks for working on this. ✌🏻 Left some comments/suggestions

emdneto · 2026-07-06T21:43:25Z

+version = "0.1.0"
+description = "OpenTelemetry reference application — rolldice (FastAPI)"
+license = "Apache-2.0"
+requires-python = ">=3.12"


Let's try to stick with the supported baseline version, which is 3.10.

emdneto · 2026-07-06T23:43:40Z

I suggest we follow the same approach as other tests and implement the logic in Python code and run it through tox, so anyone can run it locally without relying on the CI feedback. You can take a look at docker-tests

emdneto · 2026-07-07T00:07:14Z

Can we use configure_sdk from sdk._configuration module?

emdneto · 2026-07-07T00:11:16Z

+
+.. code-block:: bash
+
+   uvicorn app.main:app --host 0.0.0.0 --port 8080


I would say we can mention in advance that an OTLP backend needs to be running otherwise, the user will see a lot of failures in the logs. I know we have this instruction later in this guide, but it would be nice to "enforce" the user to have a collector running before executing this command.

emdneto · 2026-07-07T00:12:08Z

+
+.. code-block:: bash
+
+   cd instrumentation/opentelemetry-instrumentation-fastapi/examples/rolldice


Missing a fix in the path here?

emdneto · 2026-07-07T00:12:30Z

+  sampler:
+    parent_based:
+      root:
+        always_on:


Suggested change

always_on:

always_on: {}

lzchen · 2026-07-07T17:00:33Z

+  push:
+    branches: [main]
+    paths:
+      - "instrumentation/opentelemetry-instrumentation-fastapi/examples/rolldice/**"


Nit: Needs updating.

lzchen

LGTM. I think it might be worth it to wait until configure_sdk is available so we can just simply remove all the duplicate code.

github-actions · 2026-07-22T04:20:39Z

This PR has been automatically marked as stale because it has not had any activity for 14 days. It will be closed if no further activity occurs within 14 days of this comment.
If you're still working on this, please add a comment or push new commits.

github-actions · 2026-08-06T04:20:03Z

This PR has been closed due to inactivity. Please reopen if you would like to continue working on it.

reggied force-pushed the reference_app branch from 59a8eed to 2b97f1e Compare May 21, 2026 16:25

reggied and others added 2 commits May 28, 2026 08:34

Merge branch 'open-telemetry:main' into reference_app

4392aa3

reggied force-pushed the reference_app branch from 6d68bae to d871490 Compare May 28, 2026 16:24

Fix style compliance for rolldice reference application

4456610

Update all license headers to the SPDX two-line format, fix import sorting and formatting per ruff, and add a towncrier changelog fragment.

reggied marked this pull request as ready for review May 28, 2026 17:48

reggied requested a review from a team as a code owner May 28, 2026 17:48

otelbot-python Bot added this to Python PR digest May 28, 2026

reggied added 2 commits June 2, 2026 19:55

Merge branch 'main' into reference_app

57bada3

Merge branch 'main' into reference_app

e1bd722

tammy-baylis-swi moved this to Ready for review in Python PR digest Jun 11, 2026

reggied added 2 commits June 12, 2026 14:40

Merge branch 'main' into reference_app

aaa307f

Merge branch 'main' into reference_app

672004d

github-actions Bot added the Stale label Jun 30, 2026

reggied added 2 commits July 3, 2026 13:28

Merge branch 'main' into reference_app

9c72c96

Move reference app under docs/example

123e706

In response reviewer feedback, move theI roll dice reference app to the docs/examples.

github-actions Bot removed the Stale label Jul 4, 2026

Merge branch 'main' into reference_app

37147ca

emdneto reviewed Jul 7, 2026

View reviewed changes

lzchen reviewed Jul 7, 2026

View reviewed changes

lzchen approved these changes Jul 7, 2026

View reviewed changes

github-actions Bot added the Stale label Jul 22, 2026

github-actions Bot closed this Aug 6, 2026

github-project-automation Bot moved this from Ready for review to Done in Python PR digest Aug 6, 2026


		.. code-block:: bash

		uvicorn app.main:app --host 0.0.0.0 --port 8080


		.. code-block:: bash

		cd instrumentation/opentelemetry-instrumentation-fastapi/examples/rolldice

Conversation

reggied commented May 21, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Type of change

How Has This Been Tested?

Does This PR Require a Contrib Repo Change?

Checklist:

Uh oh!

linux-foundation-easycla Bot commented May 21, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

reggied commented Jun 8, 2026

Uh oh!

tammy-baylis-swi commented Jun 11, 2026

Uh oh!

reggied commented Jun 11, 2026

Uh oh!

tammy-baylis-swi commented Jun 15, 2026

Uh oh!

github-actions Bot commented Jun 30, 2026

Uh oh!

reggied commented Jul 4, 2026

Uh oh!

emdneto left a comment

Choose a reason for hiding this comment

Uh oh!

emdneto Jul 6, 2026

Choose a reason for hiding this comment

Uh oh!

emdneto Jul 6, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

emdneto Jul 7, 2026

Choose a reason for hiding this comment

Uh oh!

emdneto Jul 7, 2026

Choose a reason for hiding this comment

Uh oh!

emdneto Jul 7, 2026

Choose a reason for hiding this comment

Uh oh!

emdneto Jul 7, 2026

Choose a reason for hiding this comment

Uh oh!

lzchen Jul 7, 2026

Choose a reason for hiding this comment

Uh oh!

lzchen left a comment

Choose a reason for hiding this comment

Uh oh!

github-actions Bot commented Jul 22, 2026

Uh oh!

github-actions Bot commented Aug 6, 2026

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

reggied commented May 21, 2026 •

edited

Loading

linux-foundation-easycla Bot commented May 21, 2026 •

edited

Loading

emdneto Jul 6, 2026 •

edited

Loading