pytest-otel 1.2.1

Meta

• License: Apache Software License (Apache-2.0)
• Maintainer: Ivan Fernandez Calvo
• Tags pytest , otel , opentelemetry , debug
• Requires: Python >=3.6

Classifiers

• Environment
  • Plugins
• Framework
  • Pytest
• Intended Audience
  • Developers
• License
  • OSI Approved :: Apache Software License
• Operating System
  • OS Independent
• Programming Language
  • Python :: 3
  • Python :: 3 :: Only
  • Python :: 3.6
  • Python :: 3.7
  • Python :: 3.8
  • Python :: 3.9
  • Python :: 3.10
• Topic
  • Software Development :: Libraries
  • Software Development :: Testing
  • Utilities

Features

pytest-otel plugin for reporting APM traces of tests executed.

OpenTelemetry

Requirements

• opentelemetry-api == 1.12.0
• opentelemetry-exporter-otlp == 1.12.0
• opentelemetry-sdk == 1.12.0
• pytest >= 6.2.5

Installation

You can install "pytest-otel" via pip or using the setup.py script.

pip install pytest-otel

Usage

pytest_otel is configured by adding some parameters to the pytest command line. Below are the descriptions:

• --otel-endpoint: URL for the OpenTelemetry server. (Required). Env variable: OTEL_EXPORTER_OTLP_ENDPOINT
• --otel-headers: Additional headers to send (i.e.: key1=value1,key2=value2). Env variable: OTEL_EXPORTER_OTLP_HEADERS
• --otel-service-name: Name of the service. Env variable: OTEL_SERVICE_NAME
• --otel-session-name: Name for the main span.
• --otel-traceparent: Trace parent ID. Env variable: TRACEPARENT. See https://www.w3.org/TR/trace-context-1/#trace-context-http-headers-format
• --otel-insecure: Disables TLS. Env variable: OTEL_EXPORTER_OTLP_INSECURE

pytest--otel-endpointhttps://otelcollector.example.com:4317\
--otel-headers"authorization=Bearer ASWDCcCRFfr"\
--otel-service-namepytest_otel\
--otel-session-name='My_Test_cases'\
--otel-traceparent=00-0af7651916cd43dd8448eb211c80319c-b7ad6b7169203331-01\
--otel-insecure=False

IMPORTANT: If you use --otel-headers the transaction metadata might expose those arguments with their values. In order to avoid any credentials to be exposed, it's recommended to use the environment variables. For instance, given the above example, a similar one with environment variables can be seen below:

OTEL_EXPORTER_OTLP_ENDPOINT=https://apm.example.com:8200\
OTEL_EXPORTER_OTLP_HEADERS="authorization=Bearer ASWDCcCRFfr"\
OTEL_SERVICE_NAME=pytest_otel\
TRACEPARENT=00-0af7651916cd43dd8448eb211c80319c-b7ad6b7169203331-01\
OTEL_EXPORTER_OTLP_INSECURE=False\
pytest--otel-session-name='My_Test_cases'

Demos

• Jaeger
• Elastic Stack

License

Distributed under the terms of the Apache License Version 2.0_ license, "pytest-otel" is free and open source software

Verified details

These details have been verified by PyPI

Maintainers

👁 Avatar for kuisathaverat from gravatar.com
kuisathaverat

Unverified details

These details have not been verified by PyPI

Project links

• Homepage
• Source
• Tracker

• Download URL: pytest_otel-1.2.1.tar.gz
• Upload date: Sep 28, 2022
• Size: 11.7 kB
• Tags: Source
• Uploaded using Trusted Publishing? No
• Uploaded via: twine/4.0.1 CPython/3.9.7

Hashes for pytest_otel-1.2.1.tar.gz

Algorithm	Hash digest
SHA256	6e72a19d113c115f1b7a74ce5ef8e9980ebf023588c94ebad78f9111c378987d
MD5	39b90e4978aed928b50229c30240c140
BLAKE2b-256	a3154968e8d4fda7fe238f1fad0d8cd48d5060a836de77fbfac71da2f6fc8b78

See more details on using hashes here.

• Download URL: pytest_otel-1.2.1-py2.py3-none-any.whl
• Upload date: Sep 28, 2022
• Size: 10.8 kB
• Tags: Python 2, Python 3
• Uploaded using Trusted Publishing? No
• Uploaded via: twine/4.0.1 CPython/3.9.7

Hashes for pytest_otel-1.2.1-py2.py3-none-any.whl

Algorithm	Hash digest
SHA256	7725c6efb1da1865a68335c4bcb50da0acb50d911f1c4c4553241a0af44ff199
MD5	663322fb4a0630e4a2064ad1cd6259d8
BLAKE2b-256	9a8ecb705b5b1928ae60bf6c091d6eda44bb15bec764c4d647175bbe02190a59

See more details on using hashes here.