Skip to content

Commit 6775331

Browse files
authored
Remove local docs (#282)
Instead reference the one in https://elastic.github.io/opentelemetry/edot-sdks/python
1 parent 0705006 commit 6775331

File tree

7 files changed

+2
-618
lines changed

7 files changed

+2
-618
lines changed

README.md

Lines changed: 2 additions & 56 deletions
Original file line numberDiff line numberDiff line change
@@ -15,67 +15,13 @@ With EDOT Python you have access to all the features of the OpenTelemetry Python
1515
* Elastic-specific processors that ensure optimal compatibility when exporting OpenTelemetry signal data to an Elastic backend like an Elastic Observability deployment.
1616
* Preconfigured collection of tracing and metrics signals, applying some opinionated defaults, such as which sources are collected by default.
1717

18-
**Ready to try out EDOT Python?** Follow the step-by-step instructions in [Get started](./docs/get-started.md).
19-
20-
## Read the docs
21-
22-
* [Get started](./docs/get-started.md)
23-
* [Supported technologies](./docs/supported-techologies.md)
24-
* [Manual instrumentation](./docs/manual-instrumentation.md)
25-
* [Configuration](./docs/configure.md)
26-
* [Migrating from Elastic APM Python Agent](./docs/migrate-from-apm.md)
27-
* [Troubleshooting](./docs/troubleshooting.md)
28-
29-
## Install
30-
31-
```bash
32-
pip install elastic-opentelemetry
33-
```
34-
35-
<!-- I'll let you decide how much to keep here from the content below vs rely on content in the docs directory -->
36-
37-
## Usage
38-
39-
Our distribution does not install any instrumentation package by default, instead it relies on the
40-
`edot-bootstrap` command to scan the installed packages and install the available instrumentation, preferring EDOT variants when available.
41-
The following command will install all the instrumentations available for libraries found installed
42-
in your environment:
43-
44-
```bash
45-
edot-bootstrap --action=install
46-
```
47-
48-
It will be useful to add this command every time you need to deploy an updated version of your application,
49-
e.g. into your container image build process.
50-
51-
At runtime you have to make some environment variables available to provide the needed configuration.
52-
A *service name* is required to have your app easily recognizable from the other. Then you need to provide
53-
the *authorization* headers for authentication with Elastic cloud and the project endpoint where to send your data.
54-
55-
```bash
56-
OTEL_RESOURCE_ATTRIBUTES=service.name=<app-name>
57-
OTEL_EXPORTER_OTLP_HEADERS="Authorization=<authorization header value>"
58-
OTEL_EXPORTER_OTLP_ENDPOINT=<your elastic cloud url>
59-
```
60-
61-
We are done with the configuration and the last piece of the puzzle is wrapping your service invocation with
62-
`opentelemetry-instrument` that is the wrapper that provides *automatic instrumentation*:
63-
64-
```bash
65-
opentelemetry-instrument <command to start your service>
66-
```
67-
68-
For a web service running with gunicorn it may looks like:
69-
70-
```bash
71-
opentelemetry-instrument gunicorn main:app
72-
```
18+
**Ready to try out EDOT Python?** Follow the step-by-step instructions in [Setting up EDOT Python](https://elastic.github.io/opentelemetry/edot-sdks/python/setup/index.html).
7319

7420
## Configuration
7521

7622
The distribution supports all the configuration variables from OpenTelemetry Python project version 1.31.1.
7723

78-
See [Configuration](./docs/configure.md) for more details.
24+
See [Configuration](https://elastic.github.io/opentelemetry/edot-sdks/python/configuration.html) for more details.
7925

8026
## License
8127

docs/configure.md

Lines changed: 0 additions & 68 deletions
This file was deleted.

docs/get-started.md

Lines changed: 0 additions & 156 deletions
This file was deleted.

0 commit comments

Comments
 (0)