Add an example, import env var constants

README.md

@@ -28,7 +28,7 @@ This distribution comes with the following defaults:
 
 ## Requirements
 
-This Splunk Distribution of OpenTelemetry requires Python 3.7 or later. Supported
+This Splunk Distribution of OpenTelemetry requires Python 3.8 or later. Supported
 libraries are listed
 [here](https://github.com/open-telemetry/opentelemetry-python-contrib/tree/main/instrumentation).
 

examples/splunk_opentelemetry.py

@@ -0,0 +1,19 @@
+import os
+import time
+
+from opentelemetry import trace
+from opentelemetry.sdk.environment_variables import OTEL_SERVICE_NAME
+from splunk_otel import init_splunk_otel
+from splunk_otel.env import SPLUNK_ACCESS_TOKEN, SPLUNK_REALM
+
+os.environ[OTEL_SERVICE_NAME] = "my-svc"
+os.environ[SPLUNK_REALM] = "us1"
+os.environ[SPLUNK_ACCESS_TOKEN] = "your-splunk-access-token-here"
+
+# The `init_splunk_otel` command sets up Splunk OTel Python. It is equivalent to running `opentelemetry-instrument`.
+init_splunk_otel()
+
+tracer = trace.get_tracer("my-tracer")
+for i in range(12):
+    with tracer.start_as_current_span(f"my-span-{i}"):
+        time.sleep(0.1)

pyproject.toml

@@ -101,5 +101,5 @@ exclude_lines = [
 ]
 
 [tool.ruff.lint]
-ignore = ["FA100", "ARG002"]
+ignore = ["INP001", "FA100", "ARG002"]
 exclude = ["src/splunk_otel/profile_pb2.py"]

src/splunk_otel/env.py

@@ -14,20 +14,33 @@
 import logging
 import os
 
+from opentelemetry.environment_variables import OTEL_LOGS_EXPORTER, OTEL_METRICS_EXPORTER, OTEL_TRACES_EXPORTER
+from opentelemetry.sdk.environment_variables import (
+    OTEL_ATTRIBUTE_COUNT_LIMIT,
+    OTEL_ATTRIBUTE_VALUE_LENGTH_LIMIT,
+    OTEL_EVENT_ATTRIBUTE_COUNT_LIMIT,
+    OTEL_EXPERIMENTAL_RESOURCE_DETECTORS,
+    OTEL_LINK_ATTRIBUTE_COUNT_LIMIT,
+    OTEL_SPAN_ATTRIBUTE_COUNT_LIMIT,
+    OTEL_SPAN_EVENT_COUNT_LIMIT,
+    OTEL_SPAN_LINK_COUNT_LIMIT,
+    OTEL_TRACES_SAMPLER,
+)
+
 DEFAULTS = {
-    "OTEL_PYTHON_LOG_CORRELATION": "true",  # FIXME: revisit
-    "OTEL_TRACES_EXPORTER": "otlp",
-    "OTEL_METRICS_EXPORTER": "otlp",
-    "OTEL_LOGS_EXPORTER": "otlp",
-    "OTEL_ATTRIBUTE_COUNT_LIMIT": "",
-    "OTEL_SPAN_ATTRIBUTE_COUNT_LIMIT": "",
-    "OTEL_SPAN_EVENT_COUNT_LIMIT": "",
-    "OTEL_EVENT_ATTRIBUTE_COUNT_LIMIT": "",
-    "OTEL_LINK_ATTRIBUTE_COUNT_LIMIT": "",
-    "OTEL_SPAN_LINK_COUNT_LIMIT": "1000",
-    "OTEL_ATTRIBUTE_VALUE_LENGTH_LIMIT": "12000",
-    "OTEL_EXPERIMENTAL_RESOURCE_DETECTORS": "host,process",
-    "OTEL_TRACES_SAMPLER": "always_on",
+    "OTEL_PYTHON_LOG_CORRELATION": "true",  # used by opentelemetry-instrumentation-logging (installed by bootstrap)
+    OTEL_TRACES_EXPORTER: "otlp",
+    OTEL_METRICS_EXPORTER: "otlp",
+    OTEL_LOGS_EXPORTER: "otlp",
+    OTEL_ATTRIBUTE_COUNT_LIMIT: "",
+    OTEL_SPAN_ATTRIBUTE_COUNT_LIMIT: "",
+    OTEL_SPAN_EVENT_COUNT_LIMIT: "",
+    OTEL_EVENT_ATTRIBUTE_COUNT_LIMIT: "",
+    OTEL_LINK_ATTRIBUTE_COUNT_LIMIT: "",
+    OTEL_SPAN_LINK_COUNT_LIMIT: "1000",
+    OTEL_ATTRIBUTE_VALUE_LENGTH_LIMIT: "12000",
+    OTEL_EXPERIMENTAL_RESOURCE_DETECTORS: "host,process",
+    OTEL_TRACES_SAMPLER: "always_on",
 }
 
 OTEL_PYTHON_LOGGING_AUTO_INSTRUMENTATION_ENABLED = "OTEL_PYTHON_LOGGING_AUTO_INSTRUMENTATION_ENABLED"