Skip to content

add aiohttp example #248

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.

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
17 changes: 17 additions & 0 deletions examples/aiohttp/Dockerfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
FROM python:3.13-slim

WORKDIR /app

COPY . /app

RUN pip install aiohttp elastic-opentelemetry

# Install all the instrumentations available for the installed packages
RUN edot-bootstrap -a install

EXPOSE 8080

# Set some resource attributes to make our service recognizable
ENV OTEL_RESOURCE_ATTRIBUTES="service.name=AioHttpService,service.version=0.0.1,deployment.environment=development"

CMD ["opentelemetry-instrument", "python", "app.py"]
21 changes: 21 additions & 0 deletions examples/aiohttp/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# Aiohttp autoinstrumented application

This is a barebone aiohttp app used for demonstrating autoinstrumentation with EDOT.

You can build the application image it with:

```
docker build --load -t edot-aiohttp:latest .
```

You can run the application with:

```sh
export OTEL_EXPORTER_OTLP_ENDPOINT=https://my-deployment.apm.us-west1.gcp.cloud.es.io
export OTEL_EXPORTER_OTLP_HEADERS="Authorization=Bearer P....l"
docker run -e OTEL_EXPORTER_OTLP_ENDPOINT="$OTEL_EXPORTER_OTLP_ENDPOINT" \
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since we are using logging here I think we can can export OTEL_PYTHON_LOGGING_AUTO_INSTRUMENTATION_ENABLED=true and then update docker to forward it

-e OTEL_EXPORTER_OTLP_HEADERS="$OTEL_EXPORTER_OTLP_HEADERS" \
-p 8080:8080 -it --rm edot-aiohttp:latest
```

You can access the application from [http://127.0.0.1:8080](http://127.0.0.1:8080).
35 changes: 35 additions & 0 deletions examples/aiohttp/app.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
# or more contributor license agreements. See the NOTICE file distributed with
# this work for additional information regarding copyright
# ownership. Elasticsearch B.V. licenses this file to you under
# the Apache License, Version 2.0 (the "License"); you may
# not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

import logging
from aiohttp import web


logging.basicConfig(level=logging.INFO, format="%(asctime)s - %(levelname)s - %(message)s")
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This call to logging.basicConfig() is a no-op when the otel sdk is configured to handle logs, we can call logger.setLevel() later to get the logs exported in otlp

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Next release will have this fixed!

logger = logging.getLogger(__name__)

routes = web.RouteTableDef()


@routes.get("/")
async def hello(request):
logger.info("Hello, world")
return web.Response(text="Hello, world")


app = web.Application()
app.add_routes(routes)
web.run_app(app)