{"id":18767799,"url":"https://github.com/lightstep/otel-launcher-java","last_synced_at":"2025-06-16T15:12:08.022Z","repository":{"id":38407321,"uuid":"279327573","full_name":"lightstep/otel-launcher-java","owner":"lightstep","description":"Launcher, a Lightstep Distro for OpenTelemetry Java 🚀","archived":false,"fork":false,"pushed_at":"2023-10-06T18:17:58.000Z","size":336,"stargazers_count":15,"open_issues_count":13,"forks_count":6,"subscribers_count":50,"default_branch":"main","last_synced_at":"2025-04-20T07:45:11.609Z","etag":null,"topics":["java","opentelemetry"],"latest_commit_sha":null,"homepage":"","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/lightstep.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":"CODEOWNERS","security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2020-07-13T14:36:03.000Z","updated_at":"2023-05-30T09:58:58.000Z","dependencies_parsed_at":"2025-04-13T06:33:15.659Z","dependency_job_id":null,"html_url":"https://github.com/lightstep/otel-launcher-java","commit_stats":null,"previous_names":[],"tags_count":38,"template":false,"template_full_name":null,"purl":"pkg:github/lightstep/otel-launcher-java","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lightstep%2Fotel-launcher-java","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lightstep%2Fotel-launcher-java/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lightstep%2Fotel-launcher-java/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lightstep%2Fotel-launcher-java/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/lightstep","download_url":"https://codeload.github.com/lightstep/otel-launcher-java/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lightstep%2Fotel-launcher-java/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":260183300,"owners_count":22971201,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["java","opentelemetry"],"created_at":"2024-11-07T19:08:37.242Z","updated_at":"2025-06-16T15:12:07.976Z","avatar_url":"https://github.com/lightstep.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![Download](https://img.shields.io/maven-central/v/com.lightstep.opentelemetry/opentelemetry-launcher.svg)](http://search.maven.org/#search%7Cga%7C1%7Ccom.lightstep.opentelemetry%20opentelemetry-launcher) [![Circle CI](https://circleci.com/gh/lightstep/otel-launcher-java.svg?style=shield)](https://circleci.com/gh/lightstep/otel-launcher-java) [![Apache-2.0 license](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)\n\n# Lightstep Distro for OpenTelemetry Java [Deprecated]\n\nIn August 2023, [Lightstep became ServiceNow\nCloud Observability](https://docs.lightstep.com/docs/banner-faq). To ease the\ntransition, all code artifacts will continue to use the Lightstep name. You\ndon't need to do anything to keep using this repository.\n\nThis is the Lightstep package for configuring OpenTelemetry\n\n## Agent\nThe Lightstep OpenTelemetry Agent is a configuration layer over OpenTelemetry Instrumentation Agent.\nDownload the [latest version](https://github.com/lightstep/otel-launcher-java/releases/latest/download/lightstep-opentelemetry-javaagent.jar)\nof `lightstep-opentelemetry-javaagent.jar`.\n\n### Run\n\nThe instrumentation agent is enabled using the -javaagent flag to the JVM.\nConfiguration parameters are passed as Java system properties (-D flags) or \nas environment variables. [Full list of supported parameters](#system-properties-and-environmental-variables).\n\n#### Configuration via Java system properties\n\n```shell script\nexport LS_ACCESS_TOKEN=your-token\n\njava -javaagent:path/to/lightstep-opentelemetry-javaagent.jar \\\n     -Dotel.service.name=your-service-name\n     -Dotel.exporter.otlp.traces.endpoint=https://ingest.lightstep.com:443 \\\n     -jar myapp.jar\n```\n\n#### Configuration via environment variables\n\n```shell script\nexport LS_ACCESS_TOKEN=your-token\nexport OTEL_SERVICE_NAME=your-service-name\nexport OTEL_EXPORTER_OTLP_TRACES_ENDPOINT=https://ingest.lightstep.com:443\n\njava -javaagent:path/to/lightstep-opentelemetry-javaagent.jar \\\n     -jar myapp.jar\n```\n\nObserve that system properties have higher priority than environment variables.\n\n## Launcher\n\nThe Lightstep OpenTelemetry Launcher is a configuration layer over OpenTelemetry OTLP trace exporter.\n\n### Installation\n\npom.xml\n\n```xml\n\u003cdependency\u003e\n    \u003cgroupId\u003ecom.lightstep.opentelemetry\u003c/groupId\u003e\n    \u003cartifactId\u003eopentelemetry-launcher\u003c/artifactId\u003e\n    \u003cversion\u003eVERSION\u003c/version\u003e\n\u003c/dependency\u003e\n```\n\n### Usage\n\n#### Easy initialization\n\n```java\n// Installs exporter into tracer SDK default provider with batching span processor.\nOpenTelemetryConfiguration.newBuilder()\n                      .setServiceName(\"{service_name}\")\n                      .setAccessToken(\"{your_access_token}\")\n                      .setTracesEndpoint(\"{lightstep_host}\")\n                      .install();\n\n// Get tracer\nTracer tracer = GlobalOpenTelemetry.getTracer(\"instrumentation-library-name\", \"1.0.0\");\n```\n\n#### Manual configuration\n\n```java\n// Create builder\nBuilder builder = OpenTelemetryConfiguration.newBuilder()\n                      .setServiceName(\"{service_name}\")\n                      .setAccessToken(\"{your_access_token}\")\n                      .setTracesEndpoint(\"{lightstep_host}\");\n\n// Instantiate openTelemetry\nOpenTelemetry openTelemetry = builder.buildOpenTelemetry().getOpenTelemetrySdk();\n\n// Get tracer\nTracer tracer = openTelemetry.get(\"instrumentation-library-name\", \"1.0.0\");\n```\n\n### Logging\n\nIt uses _java.util.logging_ therefore logging properties file can be specified via system property \n_java.util.logging.config.file_. E.g. `-Djava.util.logging.config.file=path/to/logging.properties`\n\n## System properties and environmental variables\nSupported system properties and environmental variables:\n\n| System property                    | Environment variable               | Purpose                                                                           | Default              | \n|------------------------------------|------------------------------------|-----------------------------------------------------------------------------------|----------------------|       \n| otel.service.name                  | OTEL_SERVICE_NAME                  | Service name                                                                      |                      |\n| ls.service.version                 | LS_SERVICE_VERSION                 | Service version                                                                   |                      |                        \n| ls.access.token                    | LS_ACCESS_TOKEN                    | Token for Lightstep access                                                        |                      |                        \n| otel.exporter.otlp.traces.endpoint | OTEL_EXPORTER_OTLP_TRACES_ENDPOINT | Satellite URL, should start with _http://_ or _https://_                          | https://ingest.lightstep.com:443 |\n| otel.exporter.otlp.metrics.endpoint| OTEL_EXPORTER_OTLP_METRICS_ENDPOINT| Satellite URL, should start with _http://_ or _https://_                          | https://ingest.lightstep.com:443 |\n| otel.propagators                   | OTEL_PROPAGATORS                   | Propagator                                                                        | b3multi              |\n| otel.log.level                     | OTEL_LOG_LEVEL                     | Log level for agent, to see more messages set to _debug_, to disable set to _off_ | info                 |\n| otel.resource.attributes           | OTEL_RESOURCE_ATTRIBUTES           | Comma separated key-value pairs                                                   |                      |\n| otel.exporter.otlp.metrics.temporality.preference | OTEL_EXPORTER_OTLP_METRICS_TEMPORALITY_PREFERENCE | Metrics aggregation temporality                     | cumulative           |\n| ls.metrics.enabled                 | LS_METRICS_ENABLED                 | Enable or disable metrics                                                         | false                |\n\n## Deprecated properties and environmental variables\n\n| System property                    | Environment variable             |\n|------------------------------------|----------------------------------|\n| otel.exporter.otlp.span.insecure   | OTEL_EXPORTER_OTLP_SPAN_INSECURE |\n| otel.exporter.otlp.span.endpoint   | OTEL_EXPORTER_OTLP_SPAN_ENDPOINT |\n| ls.service.name                    | LS_SERVICE_NAME                  |\n\n## OpenTelemetry Metrics support\n\nMetrics support is currently **experimental** and it is disabled by default. It can be enabled via `LS_METRICS_ENABLED=true`.\nBreaking changes may still occur. Use at your own risk.\n\n## License\n\n[Apache 2.0 License](./LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flightstep%2Fotel-launcher-java","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flightstep%2Fotel-launcher-java","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flightstep%2Fotel-launcher-java/lists"}