Skip to content

Fix code examples in Starlette/FastAPI doc #1939

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

Merged
merged 2 commits into from
Nov 28, 2023
Merged

Fix code examples in Starlette/FastAPI doc #1939

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c23d7bb
Fix code examples in Starlette/FastAPI doc
uglide Nov 26, 2023
fdebdf8
Merge branch 'main' into patch-1
basepi Nov 28, 2023
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
7 changes: 4 additions & 3 deletions docs/starlette.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,7 @@ from elasticapm.contrib.starlette import make_apm_client, ElasticAPM
apm = make_apm_client({
'SERVICE_NAME': '<SERVICE-NAME>',
'SECRET_TOKEN': '<SECRET-TOKEN>',
'SERVER_URL': '<SERVER-URL>',
})
app = Starlette()
app.add_middleware(ElasticAPM, client=apm)
Expand All @@ -72,7 +73,7 @@ is almost exactly the same as with Starlette:
[source,python]
----
from fastapi import FastAPI
from elasticapm.contrib.starlette ElasticAPM
from elasticapm.contrib.starlette import ElasticAPM

app = FastAPI()
app.add_middleware(ElasticAPM)
Expand All @@ -93,14 +94,14 @@ Capture an arbitrary exception by calling
try:
1 / 0
except ZeroDivisionError:
apm.client.capture_exception()
apm.capture_exception()
----

Log a generic message with <<client-api-capture-message,`capture_message`>>:

[source,python]
----
apm.client.capture_message('hello, world!')
apm.capture_message('hello, world!')
----

[float]
Expand Down