<!--- Top of README Badges (automated) --->
[](https://app.circleci.com/pipelines/github/WIPACrepo/wipac-telemetry?branch=main&filter=all) [](https://pypi.org/project/wipac-telemetry/) [](https://github.com/WIPACrepo/wipac-telemetry/) [](https://github.com/WIPACrepo/wipac-telemetry/blob/main/LICENSE) [](https://github.com/WIPACrepo/wipac-telemetry/) [](https://github.com/WIPACrepo/wipac-telemetry/issues?q=is%3Aissue+sort%3Aupdated-desc+is%3Aopen) [](https://github.com/WIPACrepo/wipac-telemetry/pulls?q=is%3Apr+sort%3Aupdated-desc+is%3Aopen)
<!--- End of README Badges (automated) --->
# wipac-telemetry
WIPAC Telemetry: Monitoring/Tracing Applications, Supporting Infrastructures, and Services
## Tracing Tools
### Configuration
Most of the major functionality is configurable via environment variables. **_Traces are not exported by default._**
#### Environment Variables
Name | Type/Options | Description | Null Case | Example & Notes
----------------------------- | --------------------- | ------------------------------------------ | ------------------ | --------------- |
`OTEL_EXPORTER_OTLP_ENDPOINT` | string | address of collector service | no traces exported | `https://my.url.aq/traces/go/here`
`WIPACTEL_EXPORT_STDOUT` | `True` or `False` | whether to print the traces | no traces printed |
`WIPACTEL_LOGGING_LEVEL` | `debug`, `info`, etc. | minimum logging level for WIPACTEL actions | `warning` (or root logger's level if that's higher)
`WIPACTEL_SERVICE_NAME_PREFIX`| string | prefix for the tracing service's name | `""` | `mou` (results in a service called "mou/server" instead of just "server")
## Running with Local Collector Service UI (Jaegar)
1. `cd examples/telemetry-server/jaeger-production && ./start-jaeger-production.sh`
1. Open new terminal:
1. `export OTEL_EXPORTER_OTLP_ENDPOINT=http://localhost:4318/v1/traces`
1. Run script(s) and/or module(s)
1. Go to <http://localhost:16686/>
Raw data
{
"_id": null,
"home_page": "https://github.com/WIPACrepo/wipac-telemetry",
"name": "wipac-telemetry",
"maintainer": null,
"docs_url": null,
"requires_python": "<3.14,>=3.8",
"maintainer_email": null,
"keywords": "python, tools, utilities, OpenTelemetry, tracing, telemetry, WIPAC, IceCube",
"author": "WIPAC Developers",
"author_email": "developers@icecube.wisc.edu",
"download_url": "https://files.pythonhosted.org/packages/e4/4f/a81303d64996307343c4c2874976e648c8c7f454971467f21f68248d6946/wipac-telemetry-0.3.1.tar.gz",
"platform": null,
"description": "<!--- Top of README Badges (automated) --->\n[](https://app.circleci.com/pipelines/github/WIPACrepo/wipac-telemetry?branch=main&filter=all) [](https://pypi.org/project/wipac-telemetry/) [](https://github.com/WIPACrepo/wipac-telemetry/) [](https://github.com/WIPACrepo/wipac-telemetry/blob/main/LICENSE) [](https://github.com/WIPACrepo/wipac-telemetry/) [](https://github.com/WIPACrepo/wipac-telemetry/issues?q=is%3Aissue+sort%3Aupdated-desc+is%3Aopen) [](https://github.com/WIPACrepo/wipac-telemetry/pulls?q=is%3Apr+sort%3Aupdated-desc+is%3Aopen) \n<!--- End of README Badges (automated) --->\n# wipac-telemetry\nWIPAC Telemetry: Monitoring/Tracing Applications, Supporting Infrastructures, and Services\n\n## Tracing Tools\n\n### Configuration\nMost of the major functionality is configurable via environment variables. **_Traces are not exported by default._**\n\n#### Environment Variables\nName | Type/Options | Description | Null Case | Example & Notes\n----------------------------- | --------------------- | ------------------------------------------ | ------------------ | --------------- |\n`OTEL_EXPORTER_OTLP_ENDPOINT` | string | address of collector service | no traces exported | `https://my.url.aq/traces/go/here`\n`WIPACTEL_EXPORT_STDOUT` | `True` or `False` | whether to print the traces | no traces printed |\n`WIPACTEL_LOGGING_LEVEL` | `debug`, `info`, etc. | minimum logging level for WIPACTEL actions | `warning` (or root logger's level if that's higher)\n`WIPACTEL_SERVICE_NAME_PREFIX`| string | prefix for the tracing service's name | `\"\"` | `mou` (results in a service called \"mou/server\" instead of just \"server\")\n\n## Running with Local Collector Service UI (Jaegar)\n1. `cd examples/telemetry-server/jaeger-production && ./start-jaeger-production.sh`\n1. Open new terminal:\n1. `export OTEL_EXPORTER_OTLP_ENDPOINT=http://localhost:4318/v1/traces`\n1. Run script(s) and/or module(s)\n1. Go to <http://localhost:16686/>\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "WIPAC Telemetry: Monitoring/Tracing Applications, Supporting Infrastructures, and Services",
"version": "0.3.1",
"project_urls": {
"Download": "https://pypi.org/project/wipac-telemetry/",
"Homepage": "https://github.com/WIPACrepo/wipac-telemetry",
"Source": "https://github.com/WIPACrepo/wipac-telemetry",
"Tracker": "https://github.com/WIPACrepo/wipac-telemetry/issues"
},
"split_keywords": [
"python",
" tools",
" utilities",
" opentelemetry",
" tracing",
" telemetry",
" wipac",
" icecube"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "af0eb2971463f4c84c6157c6d71e7a037464aa31bf571bc88148fa07de708c84",
"md5": "d292461cbd3754f2192d516deb8449d3",
"sha256": "800eaf98786f359c9c0b7373d0fe3792250ef96047f89dc420c07f7bb47bd256"
},
"downloads": -1,
"filename": "wipac_telemetry-0.3.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d292461cbd3754f2192d516deb8449d3",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.14,>=3.8",
"size": 16634,
"upload_time": "2024-10-09T19:29:21",
"upload_time_iso_8601": "2024-10-09T19:29:21.412706Z",
"url": "https://files.pythonhosted.org/packages/af/0e/b2971463f4c84c6157c6d71e7a037464aa31bf571bc88148fa07de708c84/wipac_telemetry-0.3.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e44fa81303d64996307343c4c2874976e648c8c7f454971467f21f68248d6946",
"md5": "0839cb93e88f39b992a722d097dc202e",
"sha256": "68a45d5f6dc736cf918629a66639d9b7049b4ec99fbac759efe07c5068bdae93"
},
"downloads": -1,
"filename": "wipac-telemetry-0.3.1.tar.gz",
"has_sig": false,
"md5_digest": "0839cb93e88f39b992a722d097dc202e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.14,>=3.8",
"size": 15136,
"upload_time": "2024-10-09T19:29:22",
"upload_time_iso_8601": "2024-10-09T19:29:22.303332Z",
"url": "https://files.pythonhosted.org/packages/e4/4f/a81303d64996307343c4c2874976e648c8c7f454971467f21f68248d6946/wipac-telemetry-0.3.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-09 19:29:22",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "WIPACrepo",
"github_project": "wipac-telemetry",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"circle": true,
"lcname": "wipac-telemetry"
}
JSON
