File tree Expand file tree Collapse file tree 1 file changed +57
-0
lines changed
opentelemetry-configurator-gcp Expand file tree Collapse file tree 1 file changed +57
-0
lines changed Original file line number Diff line number Diff line change 11OpenTelemetry Google Cloud Configurator
22========================================
33
4+ Purpose
5+ -------
6+ Simplifies configuring the Open Telemetry library to write to Google Cloud Observability backends.
7+
8+
9+ Usage
10+ -----
11+
12+ There are two ways that this can be used:
13+
14+ 1. With automatic instrumentation.
15+ 2. With manual instrumentation.
16+
17+
18+ Automatic Instrumentation
19+ ^^^^^^^^^^^^^^^^^^^^^^^^^
20+
21+ To use this component with automatic instrumentation, simply invoke
22+ ``opentelemetry-instrument `` with the argument ``--configurator=gcp ``.
23+
24+ ::
25+
26+ opentelemetry-instrument \
27+ --configurator=gcp \
28+ python \
29+ the/path/to/your/code.py
30+
31+ See `Python zero-code instrumentation for Python <https://opentelemetry.io/docs/zero-code/python/ >`_
32+
33+
34+ Manual Instrumentation
35+ ^^^^^^^^^^^^^^^^^^^^^^
36+
37+ You can also call the configurator code manually.
38+
39+ ::
40+
41+ from opentelemetry.configurator.gcp import OpenTelemetryGcpConfigurator
42+
43+ OpenTelemetryGcpConfigurator().configure()
44+
45+
46+ Installation
47+ ------------
48+
49+ You can use a standard Python package management tool like ``pip `` or ``uv `` to install.
50+
51+ The PyPi package is ``opentelemetry-configurator-gcp ``.
52+
53+ For the automatic instrumentation, you must additionally install ``opentelemetry-distro ``.
54+
55+
56+ References
57+ ----------
58+
59+ * `Python zero-code instrumentation for Python <https://opentelemetry.io/docs/zero-code/python/ >`_
60+ * `Google Cloud Observability <https://cloud.google.com/stackdriver/docs >`_
You can’t perform that action at this time.
0 commit comments