splunk-opentelemetry 2.0.0a2.dev0__tar.gz → 2.2.0__tar.gz

splunk_opentelemetry-2.2.0/.github/CODEOWNERS

@@ -0,0 +1,9 @@
+*       @signalfx/gdi-python-maintainers @signalfx/gdi-python-approvers
+
+#####################################################
+#
+# Docs reviewers
+#
+#####################################################
+
+*.md @signalfx/gdi-docs @signalfx/gdi-python-maintainers @signalfx/gdi-python-approvers

splunk_opentelemetry-2.2.0/.github/dependabot.yml

@@ -0,0 +1,25 @@
+version: 2
+updates:
+  - package-ecosystem: github-actions
+    directory: /
+    schedule:
+      interval: "daily"
+    labels:
+      - "Skip Changelog"
+      - "dependencies"
+  - package-ecosystem: "pip"
+    directory: /
+    schedule:
+      interval: "daily"
+    labels:
+      - "Skip Changelog"
+      - "dependencies"
+    ignore:
+      - dependency-name: "opentelemetry-api"
+      - dependency-name: "opentelemetry-sdk"
+      - dependency-name: "opentelemetry-propagator-b3"
+      - dependency-name: "opentelemetry-exporter-otlp-proto-grpc"
+      - dependency-name: "opentelemetry-exporter-otlp-proto-http"
+      - dependency-name: "opentelemetry-instrumentation"
+      - dependency-name: "opentelemetry-instrumentation-system-metrics"
+      - dependency-name: "opentelemetry-semantic-conventions"

splunk_opentelemetry-2.0.0a2.dev0/.github/workflows/test.yml → splunk_opentelemetry-2.2.0/.github/workflows/ci-main.yml

@@ -2,9 +2,9 @@ name: test
 
 on:
   push:
-    branches: [main, v2]
+    branches: [main]
   pull_request:
-    branches: [main, v2]
+    branches: [main]
 
 concurrency:
   group: test-${{ github.head_ref }}
@@ -22,13 +22,13 @@ jobs:
       fail-fast: false
       matrix:
         os: [ubuntu-latest, windows-latest, macos-latest]
-        python-version: ['3.8', '3.9', '3.10', '3.11', '3.12']
+        python-version: ['3.8', '3.9', '3.10', '3.11', '3.12', '3.13']
 
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
 
     - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v4
+      uses: actions/setup-python@v5
       with:
         python-version: ${{ matrix.python-version }}
 

splunk_opentelemetry-2.2.0/.github/workflows/cla.yml

@@ -0,0 +1,30 @@
+name: "CLA Assistant"
+on:
+  issue_comment:
+    types: [created]
+  pull_request_target:
+    types: [opened, closed, synchronize]
+
+permissions:
+  actions: write
+  contents: read
+  pull-requests: write
+  statuses: write
+
+jobs:
+  ContributorLicenseAgreement:
+    runs-on: ubuntu-latest
+    steps:
+      - name: "CLA Assistant"
+        if: (github.event.comment.body == 'recheck' || github.event.comment.body == 'I have read the CLA Document and I hereby sign the CLA') || github.event_name == 'pull_request_target'
+        uses: contributor-assistant/github-action@v2.6.1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          PERSONAL_ACCESS_TOKEN: ${{ secrets.PAT_CLATOOL }}
+        with:
+          remote-organization-name: splunk
+          remote-repository-name: cla-agreement
+          branch: main
+          path-to-signatures: signatures/version1/cla.json
+          path-to-document: https://github.com/splunk/cla-agreement/blob/main/CLA.md
+          allowlist: dependabot[bot]

{splunk_opentelemetry-2.0.0a2.dev0 → splunk_opentelemetry-2.2.0}/.gitlab-ci.yml

@@ -10,6 +10,7 @@ stages:
   - build
   - sign
   - deploy
+  - post-release
 
 build-job:
   stage: build
@@ -35,6 +36,8 @@ checksum-signing-job:
     SIGN_TYPE: GPG
     DOWNLOAD_DIR: dist
     LOGLEVEL: DEBUG
+  only:
+    - /^v[0-9]+\.[0-9]+\.[0-9]+.*/
   artifacts:
     paths:
       - dist/
@@ -51,3 +54,14 @@ deploy-job:
   except:
     - branches
 
+publish-docker-image:
+  stage: post-release
+  image: docker:latest
+  services:
+    - docker:dind
+  variables:
+    DOCKER_TLS_CERTDIR: ""
+  only:
+    - /^v[0-9]+\.[0-9]+\.[0-9]+.*/
+  script:
+    - ./docker/publish_docker_image.sh "$CI_COMMIT_TAG"

{splunk_opentelemetry-2.0.0a2.dev0 → splunk_opentelemetry-2.2.0}/CHANGELOG.md

@@ -2,6 +2,15 @@
 
 ## Unreleased
 
+## 2.2.0 - 2025-04-03
+- Upgrade Otel dependencies to 1.31.1 / 0.52b1
+
+## 2.1.0 - 2025-02-18
+- Upgrade Otel dependencies to 1.30.0 / 0.51b0
+
+## 2.0.0 - 2025-01-28
+- See [VERSION_2_RELEASE_NOTES.md](VERSION_2_RELEASE_NOTES.md)
+
 ## 1.20.0 - 2024-08-08
 - Upgrade Otel dependencies to 1.26.0 / 0.47b0
 

{splunk_opentelemetry-2.0.0a2.dev0 → splunk_opentelemetry-2.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: splunk-opentelemetry
-Version: 2.0.0a2.dev0
+Version: 2.2.0
 Project-URL: Documentation, https://github.com/signalfx/splunk-otel-python#readme
 Project-URL: Issues, https://github.com/signalfx/splunk-otel-python/issues
 Project-URL: Source, https://github.com/signalfx/splunk-otel-python
@@ -13,17 +13,18 @@ Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
 Classifier: Programming Language :: Python :: Implementation :: CPython
 Classifier: Programming Language :: Python :: Implementation :: PyPy
 Requires-Python: >=3.8
-Requires-Dist: opentelemetry-api==1.29.0
-Requires-Dist: opentelemetry-exporter-otlp-proto-grpc==1.29.0
-Requires-Dist: opentelemetry-exporter-otlp-proto-http==1.29.0
-Requires-Dist: opentelemetry-instrumentation-system-metrics==0.50b0
-Requires-Dist: opentelemetry-instrumentation==0.50b0
-Requires-Dist: opentelemetry-propagator-b3==1.29.0
-Requires-Dist: opentelemetry-sdk==1.29.0
-Requires-Dist: opentelemetry-semantic-conventions==0.50b0
+Requires-Dist: opentelemetry-api==1.31.1
+Requires-Dist: opentelemetry-exporter-otlp-proto-grpc==1.31.1
+Requires-Dist: opentelemetry-exporter-otlp-proto-http==1.31.1
+Requires-Dist: opentelemetry-instrumentation-system-metrics==0.52b1
+Requires-Dist: opentelemetry-instrumentation==0.52b1
+Requires-Dist: opentelemetry-propagator-b3==1.31.1
+Requires-Dist: opentelemetry-sdk==1.31.1
+Requires-Dist: opentelemetry-semantic-conventions==0.52b1
 Description-Content-Type: text/markdown
 
 # splunk-opentelemetry
@@ -42,17 +43,14 @@ tracer to capture and export trace spans.
 
 This distribution comes with the following defaults:
 
-- [W3C tracecontext](https://www.w3.org/TR/trace-context/) and [W3C baggage](https://www.w3.org/TR/baggage/)
-  context propagation;
-  [B3](https://github.com/openzipkin/b3-propagation) can also be
-  [configured](https://docs.splunk.com/Observability/gdi/get-data-in/application/python/configuration/advanced-python-otel-configuration.html).
 - [OTLP gRPC exporter](https://opentelemetry-python.readthedocs.io/en/latest/exporter/otlp/otlp.html)
   configured to send spans to a locally running
-  [Splunk OpenTelemetry Connector](https://github.com/signalfx/splunk-otel-collector)
+  [Splunk OpenTelemetry Collector](https://github.com/signalfx/splunk-otel-collector)
   (`http://localhost:4317`).
 - Unlimited default limits for 
   [configuration options](https://docs.splunk.com/Observability/gdi/get-data-in/application/python/configuration/advanced-python-otel-configuration.html)
   to support full-fidelity traces.
+- Inclusion of [system metrics](https://github.com/open-telemetry/opentelemetry-python-contrib/tree/main/instrumentation/opentelemetry-instrumentation-system-metrics)
 
 ## Requirements
 
@@ -62,7 +60,8 @@ libraries are listed
 
 ## Get started
 
-For complete instructions on how to get started with the Splunk Distribution of OpenTelemetry Python, see [Instrument a Python application for Splunk Observability Cloud](https://quickdraw.splunk.com/redirect/?product=Observability&version=current&location=python.application) in the official documentation.
+For complete instructions on how to get started with the Splunk Distribution of OpenTelemetry Python, see
+[Instrument a Python application for Splunk Observability Cloud](https://quickdraw.splunk.com/redirect/?product=Observability&version=current&location=python.application) in the official documentation.
 
 
 # License
@@ -71,3 +70,9 @@ The Splunk distribution of OpenTelemetry Python Instrumentation is a
 distribution of [OpenTelemetry Python](https://github.com/open-telemetry/opentelemetry-python).
 It is licensed under the terms of the Apache Software License version 2.0.
 See [the license file](./LICENSE.txt) for more details.
+
+# Deprecation
+ℹ️ The Splunk Distribution of OpenTelemetry Python version 1.X is deprecated as of February 28, 2025 and will reach end of
+support on February 28, 2026. Existing customers should consider migrating to Splunk OpenTelemetry Python 2.0 or higher.
+See [Migrate to the Splunk Python 2.0 instrumentation](https://docs.splunk.com/observability/en/gdi/get-data-in/application/python/migration-guide.html#python-migration-guide).
+

{splunk_opentelemetry-2.0.0a2.dev0 → splunk_opentelemetry-2.2.0}/README.md

@@ -14,17 +14,14 @@ tracer to capture and export trace spans.
 
 This distribution comes with the following defaults:
 
-- [W3C tracecontext](https://www.w3.org/TR/trace-context/) and [W3C baggage](https://www.w3.org/TR/baggage/)
-  context propagation;
-  [B3](https://github.com/openzipkin/b3-propagation) can also be
-  [configured](https://docs.splunk.com/Observability/gdi/get-data-in/application/python/configuration/advanced-python-otel-configuration.html).
 - [OTLP gRPC exporter](https://opentelemetry-python.readthedocs.io/en/latest/exporter/otlp/otlp.html)
   configured to send spans to a locally running
-  [Splunk OpenTelemetry Connector](https://github.com/signalfx/splunk-otel-collector)
+  [Splunk OpenTelemetry Collector](https://github.com/signalfx/splunk-otel-collector)
   (`http://localhost:4317`).
 - Unlimited default limits for 
   [configuration options](https://docs.splunk.com/Observability/gdi/get-data-in/application/python/configuration/advanced-python-otel-configuration.html)
   to support full-fidelity traces.
+- Inclusion of [system metrics](https://github.com/open-telemetry/opentelemetry-python-contrib/tree/main/instrumentation/opentelemetry-instrumentation-system-metrics)
 
 ## Requirements
 
@@ -34,7 +31,8 @@ libraries are listed
 
 ## Get started
 
-For complete instructions on how to get started with the Splunk Distribution of OpenTelemetry Python, see [Instrument a Python application for Splunk Observability Cloud](https://quickdraw.splunk.com/redirect/?product=Observability&version=current&location=python.application) in the official documentation.
+For complete instructions on how to get started with the Splunk Distribution of OpenTelemetry Python, see
+[Instrument a Python application for Splunk Observability Cloud](https://quickdraw.splunk.com/redirect/?product=Observability&version=current&location=python.application) in the official documentation.
 
 
 # License
@@ -43,3 +41,9 @@ The Splunk distribution of OpenTelemetry Python Instrumentation is a
 distribution of [OpenTelemetry Python](https://github.com/open-telemetry/opentelemetry-python).
 It is licensed under the terms of the Apache Software License version 2.0.
 See [the license file](./LICENSE.txt) for more details.
+
+# Deprecation
+ℹ️ The Splunk Distribution of OpenTelemetry Python version 1.X is deprecated as of February 28, 2025 and will reach end of
+support on February 28, 2026. Existing customers should consider migrating to Splunk OpenTelemetry Python 2.0 or higher.
+See [Migrate to the Splunk Python 2.0 instrumentation](https://docs.splunk.com/observability/en/gdi/get-data-in/application/python/migration-guide.html#python-migration-guide).
+

splunk_opentelemetry-2.2.0/SECURITY.md

@@ -0,0 +1,25 @@
+# Security
+
+## Reporting Security Issues
+
+Please *DO NOT* report security vulnerabilities with public GitHub issue
+reports. Please [report security issues here](
+https://www.splunk.com/en_us/product-security/report.html).
+
+## Dependencies
+
+This project relies on a variety of external dependencies.
+These dependencies are monitored by
+[Dependabot](https://docs.github.com/en/code-security/supply-chain-security/configuring-dependabot-security-updates).
+Dependencies are [checked
+daily](https://github.com/signalfx/splunk-otel-python/blob/main/.github/dependabot.yml)
+and associated pull requests are opened automatically. Upgrading to the [latest
+release](https://github.com/signalfx/splunk-otel-python/releases)
+is recommended to ensure you have the latest security updates. If a security
+vulnerability is detected for a dependency of this project then either:
+
+- You are running an older release
+- A new release with the updates has not been cut yet
+- The updated dependency has not been merged likely due to some breaking change
+  (in this case, we will actively work to resolve the issue)
+- The dependency has not released an updated version with the patch

splunk_opentelemetry-2.2.0/VERSION_2_RELEASE_NOTES.md

@@ -0,0 +1,92 @@
+# Release Notes for Splunk OTel Python Version 2
+
+Summary of changes between Splunk OTel Python major versions 1 and 2.
+
+## Overview
+
+Version 2 of the Splunk Distribution of Opentelemetry Python represents a significant rewrite of the distribution,
+including a new build system using Hatch, matching the upstream Opentelemetry Python repository. As the upstream
+repository has become more mature since Splunk OTel Python 1.0 was released, version 2 has adopted
+a smaller footprint, deferring logic and spec compliance to the upstream project, while making vendor-specific features
+available for your convenience to send telemetry to Splunk Observability Cloud.
+
+## API
+
+### Version 1
+
+| Function name     | Operation                                                                                 | Arguments                                                                                               |
+|-------------------|-------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------|
+| `start_metrics()` | Configures metrics (sets up meter provider, SystemMetricsInstrumentor, and otlp exporter) | None                                                                                                    |
+| `start_tracing()` | Configures tracing (sets up tracer provider, batch span processor, and exporter)          | service_name, span_exporter_factories, access_token, resource_attributes, trace_response_header_enabled |
+
+### Version 2
+
+| Function name        | Operation                              | Arguments |
+|----------------------|----------------------------------------|-----------|
+| `init_splunk_otel()` | Initializes tracing, metrics, and logs | None      |
+
+## Environment Variables
+
+| Variable                                         | Default   | Description                                                                                          |
+|--------------------------------------------------|-----------|------------------------------------------------------------------------------------------------------|
+| SPLUNK_ACCESS_TOKEN                              |           | Adds token to requests to enable direct ingest (for skipping the Collector)                          |
+| SPLUNK_REALM                                     |           | Sets the metrics and traces endpoints by realm (e.g. `us1`) and sets the protocol to `http/protobuf` |
+| SPLUNK_PROFILER_ENABLED                          | false     | Configures the Splunk profiler to start polling at startup                                           |
+| SPLUNK_TRACE_RESPONSE_HEADER_ENABLED             | true      | Configures injection of tracecontext headers into HTTP responses if true                             |
+| SPLUNK_PROFILER_CALL_STACK_INTERVAL              | 1000      | Sets the profiler poll interval, in milliseconds                                                     |
+| SPLUNK_PROFILER_LOGS_ENDPOINT                    |           | Sets the OTel logging endpoint, only if profiler is enabled                                          |
+| OTEL_METRICS_EXPORTER                            | otlp      | Sets the metrics exporter                                                                            |
+| OTEL_TRACES_EXPORTER                             | otlp      | Sets the traces exporter                                                                             |
+| OTEL_LOGS_EXPORTER                               | otlp      | Sets the logs exporter                                                                               |
+| OTEL_EXPERIMENTAL_RESOURCE_DETECTORS             | host      | Configures a host resource detector to set telemetry attributes                                      |
+| OTEL_TRACES_SAMPLER                              | always_on | Configures the sampler to export all traces                                                          |
+| OTEL_PYTHON_LOGGING_AUTO_INSTRUMENTATION_ENABLED | true      | Exports all logs                                                                                     |
+| OTEL_SPAN_LINK_COUNT_LIMIT                       | 1000      | Sets the maximum allowed span link count                                                             |
+| OTEL_ATTRIBUTE_VALUE_LENGTH_LIMIT                | 12000     | Sets the maximum allowed attribute value size                                                        |
+| OTEL_ATTRIBUTE_COUNT_LIMIT                       | _empty_   |                                                                                                      |
+| OTEL_SPAN_ATTRIBUTE_COUNT_LIMIT                  | _empty_   |                                                                                                      |
+| OTEL_SPAN_EVENT_COUNT_LIMIT                      | _empty_   |                                                                                                      |
+| OTEL_EVENT_ATTRIBUTE_COUNT_LIMIT                 | _empty_   |                                                                                                      |
+| OTEL_LINK_ATTRIBUTE_COUNT_LIMIT                  | _empty_   |                                                                                                      |
+
+## Environment Variable Changes Between 1.x and 2.x
+
+| Variable                             | Changes in 2.x                                                                  |
+|--------------------------------------|---------------------------------------------------------------------------------|
+| OTEL_METRICS_ENABLED                 | Removed (set `OTEL_PYTHON_DISABLED_INSTRUMENTATIONS=system_metrics` to disable) |
+| OTEL_METRICS_EXPORTER                | Overridden in 1.x, configurable in 2.x                                          |
+| OTEL_TRACE_ENABLED                   | Removed (defaulted to `true`)                                                   |
+| OTEL_PYTHON_LOG_CORRELATION          | No longer set (previously reformatted logs, adding trace IDs)                   |
+| OTEL_METRICS_EXPORTER                | Added                                                                           |
+| OTEL_LOGS_EXPORTER                   | Added                                                                           |
+| OTEL_EXPERIMENTAL_RESOURCE_DETECTORS | Added                                                                           |
+| OTEL_TRACES_SAMPLER                  | Added (previously defaulted to `parentbased_always_on`)                         |
+
+## Auto-instrumentation
+
+Version 1 of Splunk OTel Python supplied a script to run a python application with OTel auto instrumentation. For
+example:
+
+`$ splunk-py-trace python myapp.py`
+
+In version 2 of Splunk OTel Python, the `splunk-py-trace` command is replaced by `opentelemetry-instrument`, the same
+command supplied by the core OpenTelemetry Python project.
+
+| Version | Commands                           |
+|---------|------------------------------------|
+| 1.x     | `splunk-py-trace`, `splk-py-trace` |
+| 2.x     | `opentelemetry-instrument`         |
+
+## Bootstrap Script
+
+Version 1 of Splunk OTel Python supplied a script to install instrumentation libraries based on the packages
+already installed in the current environment. In version 2 the `splunk-py-trace-bootstrap` command is replaced by
+`opentelemetry-bootstrap`, the same command supplied by the core OpenTelemetry Python project.
+
+| Version | Commands                                               |
+|---------|--------------------------------------------------------|
+| 1.x     | `splunk-py-trace-bootstrap`, `splk-py-trace-bootstrap` |
+| 2.x     | `opentelemetry-bootstrap`                              |
+
+> **Note:** `opentelemetry-bootstrap` does not install packages automatically. You need to pass it the `-a install`
+> flag to install them.

splunk_opentelemetry-2.2.0/docker/Dockerfile

@@ -0,0 +1,13 @@
+FROM python:3.11 AS build
+
+WORKDIR /operator-build
+
+ADD requirements.txt .
+
+RUN mkdir workspace && pip install --target workspace -r requirements.txt
+
+FROM busybox
+
+COPY --from=build /operator-build/workspace /autoinstrumentation
+
+RUN chmod -R go+r /autoinstrumentation

splunk_opentelemetry-2.2.0/docker/README.md

@@ -0,0 +1,98 @@
+# Overview
+
+This directory contains a Dockerfile and an `example-instrumentation.yaml` file for creating a
+Docker init container that can be used to auto-instrumetation your Python app via the kubernetes
+[OTel Operator](https://github.com/open-telemetry/opentelemetry-operator).
+
+# Installation
+
+Install [cert manager](https://cert-manager.io/docs/installation/) into your k8s cluster unless already installed.
+
+Install the OTel Operator Custom Resource Definitions:
+
+```
+kubectl apply -f https://github.com/open-telemetry/opentelemetry-operator/releases/latest/download/opentelemetry-operator.yaml
+```
+
+Install an _OpenTelemetryCollector_ definition into the k8s cluster. The following defines a Collector sidecar that
+just prints debug statements.
+
+```yaml
+apiVersion: opentelemetry.io/v1beta1
+kind: OpenTelemetryCollector
+metadata:
+  name: my-sidecar
+spec:
+  mode: sidecar
+  config:
+    receivers:
+      otlp:
+        protocols:
+          grpc:
+            endpoint: 0.0.0.0:4317
+          http:
+            endpoint: 0.0.0.0:4318
+    exporters:
+      debug: {}
+    service:
+      pipelines:
+        traces:
+          receivers: [otlp]
+          exporters: [debug]
+```
+
+Install an _Instrumentation_ definition. It will be activated when you create an app with an `inject-python` annotation,
+running an _init_ container before your Python app. The init container makes OTel libraries (including a
+`sitecustomize.py`) available at `/otel-auto-instrumentation-python` and sets the PYTHONPATH for the starting
+application.
+
+
+```yaml
+apiVersion: opentelemetry.io/v1alpha1
+kind: Instrumentation
+metadata:
+  name: splunk-otel-python
+spec:
+  exporter:
+    endpoint: http://localhost:4318
+  sampler:
+    type: always_on
+  python:
+    env:
+      - name: OTEL_EXPORTER_OTLP_PROTOCOL
+        value: http/protobuf
+    image: "splunk-otel-python-init:v2.0.0"
+
+```
+
+Create an application image and run it via something like this Deployment. Note the annotations, indicating that
+we want both Python auto instrumentation installed and our sidecar Collector to run.
+
+```yaml
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  name: ticker
+spec:
+  selector:
+    matchLabels:
+      app: ticker
+  replicas: 1
+  template:
+    metadata:
+      labels:
+        app: ticker
+      annotations:
+        sidecar.opentelemetry.io/inject: "true"
+        instrumentation.opentelemetry.io/inject-python: "true"
+    spec:
+      containers:
+      - name: ticker
+        image: ticker:v1
+        env:
+        - name: PYTHONUNBUFFERED
+          value: "1"
+```
+
+When you run this application, k8s should create a pod with a Collector sidecar and auto instrumentation enabled. You
+can check the Collector logs to make sure it's receiving data.

splunk_opentelemetry-2.2.0/docker/common.sh

@@ -0,0 +1,73 @@
+#!/usr/bin/env bash
+
+# Common functions used during the release process on GitLab
+
+set -e
+
+setup_gpg() {
+  echo ">>> Setting GnuPG configuration ..."
+  mkdir -p ~/.gnupg
+  chmod 700 ~/.gnupg
+  cat > ~/.gnupg/gpg.conf <<EOF
+no-tty
+pinentry-mode loopback
+EOF
+}
+
+import_gpg_secret_key() {
+  local secret_key_contents="$1"
+
+  echo ">>> Importing secret key ..."
+  echo "$secret_key_contents" > seckey.gpg
+  if (gpg --batch --allow-secret-key-import --import seckey.gpg)
+  then
+    rm seckey.gpg
+  else
+    rm seckey.gpg
+    exit 1
+  fi
+}
+
+sign_file() {
+  local file="$1"
+  echo "$GPG_PASSWORD" | \
+    gpg --batch --passphrase-fd 0 --armor --local-user="$GPG_KEY_ID" --detach-sign "$file"
+}
+
+setup_git() {
+  git config --global user.name release-bot
+  git config --global user.email ssg-srv-gh-o11y-gdi@splunk.com
+  git config --global gpg.program gpg
+  git config --global user.signingKey "$GITHUB_BOT_GPG_KEY_ID"
+}
+
+# input must include starting 'v'.
+# this strips it and returns version minus leading v.
+get_release_version() {
+  local release_tag="$1"
+  echo "$release_tag" | cut -c2-
+}
+
+# 1 from v1.2.3
+get_major_version() {
+  local release_tag="$1"
+  get_release_version "$release_tag" | awk -F'.' '{print $1}'
+}
+get_minor_version() {
+  local release_tag="$1"
+  get_release_version "$release_tag" | awk -F'.' '{print $2}'
+}
+get_patch_version() {
+  local release_tag="$1"
+  get_release_version "$release_tag" | awk -F'[.-]' '{print $3}'
+}
+
+validate_version() {
+  local version="$1"
+  if [[ ! $version =~ ^[0-9]+\.[0-9]+\.[0-9]+(-.*)?$ ]]
+  then
+    echo "Invalid release version: $version"
+    echo "Release version must follow the pattern major.minor.patch, e.g. 1.2.3"
+    exit 1
+  fi
+}

splunk_opentelemetry-2.2.0/docker/example-instrumentation.yaml

@@ -0,0 +1,14 @@
+apiVersion: opentelemetry.io/v1alpha1
+kind: Instrumentation
+metadata:
+  name: splunk-otel-python
+spec:
+  exporter:
+    endpoint: http://localhost:4318
+  sampler:
+    type: always_on
+  python:
+    env:
+      - name: OTEL_EXPORTER_OTLP_PROTOCOL
+        value: http/protobuf
+    image: "splunk-otel-instrumentation-python:v2.1.0"

splunk_opentelemetry-2.2.0/docker/publish-docker-image.sh

@@ -0,0 +1,32 @@
+#!/usr/bin/env bash
+set -e
+
+cd docker
+
+release_tag="$1" # e.g. v1.2.3
+major_version=$(echo $release_tag | cut -d '.' -f1) # e.g. "v1"
+repo="quay.io/signalfx/splunk-otel-instrumentation-python"
+
+build_docker_image() {
+  echo ">>> Building the operator docker image ..."
+  docker build -t splunk-otel-instrumentation-python .
+  docker tag splunk-otel-instrumentation-python ${repo}:latest
+  docker tag splunk-otel-instrumentation-python ${repo}:${major_version}
+  docker tag splunk-otel-instrumentation-python ${repo}:${release_tag}
+}
+
+login_to_quay_io() {
+  echo ">>> Logging into quay.io ..."
+  docker login -u "$QUAY_USERNAME" -p "$QUAY_PASSWORD" quay.io
+}
+
+publish_docker_image() {
+  echo ">>> Publishing the operator docker image ..."
+  docker push ${repo}:latest
+  docker push ${repo}:${major_version}
+  docker push ${repo}:${release_tag}
+}
+
+build_docker_image
+login_to_quay_io
+publish_docker_image

splunk_opentelemetry-2.2.0/docker/requirements.txt

@@ -0,0 +1 @@
+splunk-opentelemetry==2.1.0

splunk_opentelemetry-2.0.0a2.dev0/examples/splunk_opentelemetry.py → splunk_opentelemetry-2.2.0/examples/trace_example.py

@@ -8,9 +8,9 @@ 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"
+os.environ[SPLUNK_ACCESS_TOKEN] = "abc123"
 
-# The `init_splunk_otel` command sets up Splunk OTel Python. It is equivalent to running `opentelemetry-instrument`.
+# The `init_splunk_otel` function configures OTel metrics, traces, and logs.
 init_splunk_otel()
 
 tracer = trace.get_tracer("my-tracer")

{splunk_opentelemetry-2.0.0a2.dev0 → splunk_opentelemetry-2.2.0}/pyproject.toml

@@ -19,18 +19,19 @@ classifiers = [
   "Programming Language :: Python :: 3.10",
   "Programming Language :: Python :: 3.11",
   "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: 3.13",
   "Programming Language :: Python :: Implementation :: CPython",
   "Programming Language :: Python :: Implementation :: PyPy",
 ]
 dependencies = [
-  "opentelemetry-api==1.29.0",
-  "opentelemetry-sdk==1.29.0",
-  "opentelemetry-propagator-b3==1.29.0",
-  "opentelemetry-exporter-otlp-proto-grpc==1.29.0",
-  "opentelemetry-exporter-otlp-proto-http==1.29.0",
-  "opentelemetry-instrumentation==0.50b0",
-  "opentelemetry-instrumentation-system-metrics==0.50b0",
-  "opentelemetry-semantic-conventions==0.50b0",
+  "opentelemetry-api==1.31.1",
+  "opentelemetry-sdk==1.31.1",
+  "opentelemetry-propagator-b3==1.31.1",
+  "opentelemetry-exporter-otlp-proto-grpc==1.31.1",
+  "opentelemetry-exporter-otlp-proto-http==1.31.1",
+  "opentelemetry-instrumentation==0.52b1",
+  "opentelemetry-instrumentation-system-metrics==0.52b1",
+  "opentelemetry-semantic-conventions==0.52b1",
 ]
 
 [project.urls]

{splunk_opentelemetry-2.0.0a2.dev0 → splunk_opentelemetry-2.2.0}/src/splunk_otel/__about__.py

@@ -13,15 +13,4 @@
 #  limitations under the License.
 
 
-__version__ = "2.0.0a2.dev0"
-"""
-explanation:
-2.0.0a1 (alpha release 1 of version 2.0.0)
-2.0.0a1.dev0 (development version zero of the next release)
-2.0.0b1 (beta release 1 of version 2.0.0)
-2.0.0rc1 (release candidate 1 of version 2.0.0)
-
-installation:
-pip install --pre splunk-opentelemetry
-pip install splunk-opentelemetry==2.0.0a1
-"""
+__version__ = "2.2.0"

{splunk_opentelemetry-2.0.0a2.dev0 → splunk_opentelemetry-2.2.0}/src/splunk_otel/distro.py

@@ -57,7 +57,6 @@ class SplunkDistro(BaseDistro):
     def __init__(self):
         # can't accept an arg here because of the parent class
         self.env = Env()
-        self.logger = logging.getLogger(__name__)
 
     def _configure(self, **kwargs):
         self.set_env_defaults()
@@ -68,31 +67,15 @@ class SplunkDistro(BaseDistro):
         self.configure_token_headers()
         self.set_server_timing_propagator()
 
-    def handle_realm(self):
-        realm = self.env.getval(SPLUNK_REALM)
-        if len(realm):
-            ingest_url = f"https://ingest.{realm}.signalfx.com"
-            self.env.setdefault(
-                OTEL_EXPORTER_OTLP_TRACES_ENDPOINT,
-                f"{ingest_url}/v2/trace/otlp",
-            )
-            self.env.setdefault(
-                OTEL_EXPORTER_OTLP_METRICS_ENDPOINT,
-                f"{ingest_url}/v2/datapoint/otlp",
-            )
-
-            # if realm is set, we assume direct ingest and set the protocol to `http/proto`
-            self.env.setdefault(OTEL_EXPORTER_OTLP_PROTOCOL, "http/protobuf")
+    def set_env_defaults(self):
+        for key, value in DEFAULTS.items():
+            self.env.setdefault(key, value)
 
     def check_service_name(self):
         if not len(self.env.getval(OTEL_SERVICE_NAME)):
             _pylogger.warning(_NO_SERVICE_NAME_WARNING)
             self.env.setval(OTEL_SERVICE_NAME, _DEFAULT_SERVICE_NAME)
 
-    def set_env_defaults(self):
-        for key, value in DEFAULTS.items():
-            self.env.setdefault(key, value)
-
     def set_profiling_env(self):
         if self.env.is_true(SPLUNK_PROFILER_ENABLED, "false"):
             logs_endpt = self.env.getval(SPLUNK_PROFILER_LOGS_ENDPOINT)
@@ -103,6 +86,22 @@ class SplunkDistro(BaseDistro):
         self.env.list_append(OTEL_RESOURCE_ATTRIBUTES, f"telemetry.distro.name={_DISTRO_NAME}")
         self.env.list_append(OTEL_RESOURCE_ATTRIBUTES, f"telemetry.distro.version={version}")
 
+    def handle_realm(self):
+        realm = self.env.getval(SPLUNK_REALM)
+        if len(realm):
+            ingest_url = f"https://ingest.{realm}.signalfx.com"
+            self.env.setdefault(
+                OTEL_EXPORTER_OTLP_TRACES_ENDPOINT,
+                f"{ingest_url}/v2/trace/otlp",
+            )
+            self.env.setdefault(
+                OTEL_EXPORTER_OTLP_METRICS_ENDPOINT,
+                f"{ingest_url}/v2/datapoint/otlp",
+            )
+
+            # if realm is set, we assume direct ingest and set the protocol to `http/protobuf`
+            self.env.setdefault(OTEL_EXPORTER_OTLP_PROTOCOL, "http/protobuf")
+
     def configure_token_headers(self):
         tok = self.env.getval(SPLUNK_ACCESS_TOKEN).strip()
         if tok:

{splunk_opentelemetry-2.0.0a2.dev0 → splunk_opentelemetry-2.2.0}/src/splunk_otel/env.py

@@ -27,8 +27,10 @@ from opentelemetry.sdk.environment_variables import (
     OTEL_TRACES_SAMPLER,
 )
 
+OTEL_PYTHON_LOGGING_AUTO_INSTRUMENTATION_ENABLED = "OTEL_PYTHON_LOGGING_AUTO_INSTRUMENTATION_ENABLED"
+
 DEFAULTS = {
-    "OTEL_PYTHON_LOGGING_AUTO_INSTRUMENTATION_ENABLED": "true",
+    OTEL_PYTHON_LOGGING_AUTO_INSTRUMENTATION_ENABLED: "true",
     OTEL_TRACES_EXPORTER: "otlp",
     OTEL_METRICS_EXPORTER: "otlp",
     OTEL_LOGS_EXPORTER: "otlp",

{splunk_opentelemetry-2.0.0a2.dev0 → splunk_opentelemetry-2.2.0}/tests/ott_lib.py

@@ -3,6 +3,8 @@ from pathlib import Path
 
 from opentelemetry import trace
 
+UPSTREAM_PRERELEASE_VERSION = "0.51b0"
+
 
 def project_path():
     return str(Path(__file__).parent.parent)

{splunk_opentelemetry-2.0.0a2.dev0 → splunk_opentelemetry-2.2.0}/tests/ott_logging.py

@@ -1,7 +1,7 @@
 import logging
 
 from opentelemetry import trace
-from ott_lib import project_path
+from ott_lib import UPSTREAM_PRERELEASE_VERSION, project_path
 
 MESSAGE = "uh oh!"
 LOGGER_NAME = "logging-ott"
@@ -17,7 +17,7 @@ if __name__ == "__main__":
 
 class LoggingOtelTest:
     def requirements(self):
-        return project_path(), "opentelemetry-instrumentation-logging==0.49b2"
+        return project_path(), f"opentelemetry-instrumentation-logging=={UPSTREAM_PRERELEASE_VERSION}"
 
     def environment_variables(self):
         return {

{splunk_opentelemetry-2.0.0a2.dev0 → splunk_opentelemetry-2.2.0}/tests/ott_propagator.py

@@ -1,7 +1,7 @@
 from typing import Mapping, Optional, Sequence
 
 from oteltest import OtelTest, Telemetry
-from ott_lib import project_path
+from ott_lib import UPSTREAM_PRERELEASE_VERSION, project_path
 
 PORT = 8888
 
@@ -35,7 +35,7 @@ class OTT(OtelTest):
             project_path(),
             "oteltest",
             "flask",
-            "opentelemetry-instrumentation-flask",
+            f"opentelemetry-instrumentation-flask=={UPSTREAM_PRERELEASE_VERSION}",
         ]
 
     def wrapper_command(self) -> str:

{splunk_opentelemetry-2.0.0a2.dev0 → splunk_opentelemetry-2.2.0}/tests/ott_trace_loop.py

@@ -1,4 +1,3 @@
-from oteltest.telemetry import count_spans, extract_leaves, get_attribute
 from ott_lib import project_path, trace_loop
 
 NUM_SPANS = 12
@@ -23,6 +22,8 @@ class NumSpansOtelTest:
         return None
 
     def on_stop(self, telemetry, stdout: str, stderr: str, returncode: int) -> None:
+        from oteltest.telemetry import count_spans, extract_leaves, get_attribute
+
         assert count_spans(telemetry) == NUM_SPANS
 
         attributes = extract_leaves(telemetry, "trace_requests", "pbreq", "resource_spans", "resource", "attributes")

splunk_opentelemetry-2.0.0a2.dev0/RELEASE_NOTES.md

@@ -1,61 +0,0 @@
-# Release Notes for Splunk OTel Python Version 2
-
-Summary of changes between Splunk OTel Python major versions 1 and 2.
-
-## API
-
-### Version 1
-
-| Function name     | Operation                                                                                 | Arguments                                                                                               |
-|-------------------|-------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------|
-| `start_metrics()` | Configures metrics (sets up meter provider, SystemMetricsInstrumentor, and otlp exporter) | None                                                                                                    |
-| `start_tracing()` | Configures tracing (sets up tracer provider, batch span processor, and exporter)          | service_name, span_exporter_factories, access_token, resource_attributes, trace_response_header_enabled |
-
-### Version 2
-
-| Function name        | Operation                              | Arguments |
-|----------------------|----------------------------------------|-----------|
-| `init_splunk_otel()` | Initializes tracing, metrics, and logs | None      |
-
-## Environment Variables
-
-| Variable                              | v2 default | v1 -> v2 changes                                                                | Description                                                                                                        |
-|---------------------------------------|------------|---------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------|
-| SPLUNK_ACCESS_TOKEN                   |            | None                                                                            | Adds token to requests to enable direct ingest (for skipping the collector)                                        |
-| OTEL_METRICS_ENABLED                  | [n/a]      | Removed. Set `OTEL_PYTHON_DISABLED_INSTRUMENTATIONS=system_metrics` to disable. | Caused metrics to be configured (with an otlp-grpc metric exporter and a SystemMetricInstrumentor)                 |
-| OTEL_METRICS_EXPORTER                 | otlp       | Hard coded in v1, configurable in v2                                            | Indicates the metrics exporter                                                                                     |
-| OTEL_TRACE_ENABLED                    | true       | None                                                                            | Causes tracing to be configured and instrumentors loaded                                                           |
-| OTEL_TRACES_EXPORTER                  | otlp       | None                                                                            | Indicates the traces exporter                                                                                      |
-| OTEL_PYTHON_DISABLED_INSTRUMENTATIONS |            | None                                                                            | Disables instrumentations by entrypoint name                                                                       |
-| SPLUNK_PROFILER_ENABLED               | false      | None                                                                            | Causes the Splunk profiler to start polling at startup                                                             |
-| OTEL_SPAN_LINK_COUNT_LIMIT            | 1000       | None                                                                            | Sets the maximum allowed span link count                                                                           |
-| OTEL_ATTRIBUTE_VALUE_LENGTH_LIMIT     | 12000      | None                                                                            | Sets the maximum allowed attribute value size                                                                      |
-| SPLUNK_TRACE_RESPONSE_HEADER_ENABLED  | true       | None                                                                            | Causes a ServerTimingReponsePropagator to be configured if true (injects tracecontext headers into HTTP responses) |
-| OTEL_EXPERIMENTAL_RESOURCE_DETECTORS  | host       | Not set in v1                                                                   | Causes a host resource detector to be configured to set telemetry attributes                                       |
-| OTEL_TRACES_SAMPLER                   | always_on  | Not set in v1 (took upstream default of parentbased_always_on)                  |                                                                                                                    |
-
-## Auto-instrumentation
-
-Version 1 of Splunk OTel Python supplied a script to run a python application with OTel auto instrumentation. For
-example:
-
-`$ splunk-py-trace python myapp.apy`
-
-In version 2 of Splunk OTel Python, the `splunk-py-trace` command is replaced by `opentelemetry-instrument`, the same
-command supplied by the core OpenTelemetry Python project.
-
-| Version | Commands                           |
-|---------|------------------------------------|
-| 1.x     | `splunk-py-trace`, `splk-py-trace` |
-| 2.x     | `opentelemetry-instrument`         |
-
-## Bootstrap Script
-
-Version 1 of Splunk OTel Python supplied a script to install instrumentation libraries based on the packages
-already installed in the current environment. In version 2 the `splunk-py-trace-bootstrap` command is replaced by
-`opentelemetry-bootstrap`, the same command supplied by the core OpenTelemetry Python project.
-
-| Version | Commands                                               |
-|---------|--------------------------------------------------------|
-| 1.x     | `splunk-py-trace-bootstrap`, `splk-py-trace-bootstrap` |
-| 2.x     | `opentelemetry-bootstrap`                              |