wipac-telemetry


Namewipac-telemetry JSON
Version 0.3.0 PyPI version JSON
download
home_pagehttps://github.com/WIPACrepo/wipac-telemetry
SummaryWIPAC Telemetry: Monitoring/Tracing Applications, Supporting Infrastructures, and Services
upload_time2023-10-03 21:11:16
maintainer
docs_urlNone
authorWIPAC Developers
requires_python<3.13,>=3.8
licenseMIT
keywords python tools utilities opentelemetry tracing telemetry wipac icecube
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            <!--- Top of README Badges (automated) --->
[![CircleCI](https://img.shields.io/circleci/build/github/WIPACrepo/wipac-telemetry)](https://app.circleci.com/pipelines/github/WIPACrepo/wipac-telemetry?branch=main&filter=all) [![PyPI](https://img.shields.io/pypi/v/wipac-telemetry)](https://pypi.org/project/wipac-telemetry/) [![GitHub release (latest by date including pre-releases)](https://img.shields.io/github/v/release/WIPACrepo/wipac-telemetry?include_prereleases)](https://github.com/WIPACrepo/wipac-telemetry/) [![PyPI - License](https://img.shields.io/pypi/l/wipac-telemetry)](https://github.com/WIPACrepo/wipac-telemetry/blob/main/LICENSE) [![Lines of code](https://img.shields.io/tokei/lines/github/WIPACrepo/wipac-telemetry)](https://github.com/WIPACrepo/wipac-telemetry/) [![GitHub issues](https://img.shields.io/github/issues/WIPACrepo/wipac-telemetry)](https://github.com/WIPACrepo/wipac-telemetry/issues?q=is%3Aissue+sort%3Aupdated-desc+is%3Aopen) [![GitHub pull requests](https://img.shields.io/github/issues-pr/WIPACrepo/wipac-telemetry)](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": "",
    "docs_url": null,
    "requires_python": "<3.13,>=3.8",
    "maintainer_email": "",
    "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/21/1c/48c285324bdf321bf1894ee8f9fb724f4e75b814bc846d96ebc22330c595/wipac-telemetry-0.3.0.tar.gz",
    "platform": null,
    "description": "<!--- Top of README Badges (automated) --->\n[![CircleCI](https://img.shields.io/circleci/build/github/WIPACrepo/wipac-telemetry)](https://app.circleci.com/pipelines/github/WIPACrepo/wipac-telemetry?branch=main&filter=all) [![PyPI](https://img.shields.io/pypi/v/wipac-telemetry)](https://pypi.org/project/wipac-telemetry/) [![GitHub release (latest by date including pre-releases)](https://img.shields.io/github/v/release/WIPACrepo/wipac-telemetry?include_prereleases)](https://github.com/WIPACrepo/wipac-telemetry/) [![PyPI - License](https://img.shields.io/pypi/l/wipac-telemetry)](https://github.com/WIPACrepo/wipac-telemetry/blob/main/LICENSE) [![Lines of code](https://img.shields.io/tokei/lines/github/WIPACrepo/wipac-telemetry)](https://github.com/WIPACrepo/wipac-telemetry/) [![GitHub issues](https://img.shields.io/github/issues/WIPACrepo/wipac-telemetry)](https://github.com/WIPACrepo/wipac-telemetry/issues?q=is%3Aissue+sort%3Aupdated-desc+is%3Aopen) [![GitHub pull requests](https://img.shields.io/github/issues-pr/WIPACrepo/wipac-telemetry)](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.0",
    "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": "81394d337fd27565ffc203e8419bf5a565760bfeb71894467e796955fe522672",
                "md5": "799e13eb7dbb634e6e9c3253c0b58252",
                "sha256": "9b070d54fcd98a95e7a2791d1eaa1f9b96b1c2409568d87148bef8300c5e6789"
            },
            "downloads": -1,
            "filename": "wipac_telemetry-0.3.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "799e13eb7dbb634e6e9c3253c0b58252",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<3.13,>=3.8",
            "size": 16630,
            "upload_time": "2023-10-03T21:11:14",
            "upload_time_iso_8601": "2023-10-03T21:11:14.339892Z",
            "url": "https://files.pythonhosted.org/packages/81/39/4d337fd27565ffc203e8419bf5a565760bfeb71894467e796955fe522672/wipac_telemetry-0.3.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "211c48c285324bdf321bf1894ee8f9fb724f4e75b814bc846d96ebc22330c595",
                "md5": "fe3cc22903f2d500d2840fffba757878",
                "sha256": "10cdca73a2e627c30e3aab009c5da9a8747b4de0898e3774e2dcf520663b4742"
            },
            "downloads": -1,
            "filename": "wipac-telemetry-0.3.0.tar.gz",
            "has_sig": false,
            "md5_digest": "fe3cc22903f2d500d2840fffba757878",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<3.13,>=3.8",
            "size": 15142,
            "upload_time": "2023-10-03T21:11:16",
            "upload_time_iso_8601": "2023-10-03T21:11:16.153124Z",
            "url": "https://files.pythonhosted.org/packages/21/1c/48c285324bdf321bf1894ee8f9fb724f4e75b814bc846d96ebc22330c595/wipac-telemetry-0.3.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-10-03 21:11:16",
    "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"
}
        
Elapsed time: 0.13163s