[ { "path": ".dockerignore", "content": "# https://docs.docker.com/engine/reference/builder/#dockerignore-file\n**\n\n# Scripts that run within Docker\n!build-bin/maybe_install_npm\n!build-bin/maven/maven_build\n!build-bin/maven/maven_build_or_unjar\n!build-bin/maven/maven_opts\n!build-bin/maven/maven_unjar\n!build-bin/docker/docker-healthcheck\n\n!docker/start-zipkin\n!/zipkin-server/target/zipkin-server-*exec.jar\n!/zipkin-server/target/zipkin-server-*slim.jar\n\n!docker/test-images/zipkin-activemq/start-activemq\n\n!docker/test-images/zipkin-cassandra/install.sh\n!docker/test-images/zipkin-cassandra/start-cassandra\n!zipkin-storage/cassandra/src/main/resources/*.cql\n\n!docker/test-images/zipkin-elasticsearch7/config/\n!docker/test-images/zipkin-elasticsearch7/start-elasticsearch\n!docker/test-images/zipkin-elasticsearch8/config/\n!docker/test-images/zipkin-elasticsearch8/start-elasticsearch\n\n!docker/test-images/zipkin-opensearch2/config/\n!docker/test-images/zipkin-opensearch2/start-opensearch\n\n!docker/test-images/zipkin-eureka/src/\n!docker/test-images/zipkin-eureka/pom.xml\n!docker/test-images/zipkin-eureka/start-eureka\n\n!docker/test-images/zipkin-kafka/install.sh\n!docker/test-images/zipkin-kafka/start-kafka-zookeeper\n\n!docker/test-images/zipkin-mysql/install.sh\n!docker/test-images/zipkin-mysql/start-mysql\n!zipkin-storage/mysql-v1/src/main/resources/mysql.sql\n\n!docker/test-images/zipkin-rabbitmq/config/\n\n!docker/test-images/zipkin-ui/nginx.conf\n!docker/test-images/zipkin-ui/start-nginx\n!zipkin-lens/target/zipkin-lens-*.jar\n\n!docker/test-images/zipkin-uiproxy/nginx.conf\n!docker/test-images/zipkin-uiproxy/start-nginx\n\n# Allow on-demand \"mvn package\". referenced in pom.xml must be added even if not built\n!zipkin/src/main/**\n!zipkin-collector/src/main/**\n!zipkin-collector/core/src/main/**\n!zipkin-collector/activemq/src/main/**\n!zipkin-collector/kafka/src/main/**\n!zipkin-collector/rabbitmq/src/main/**\n!zipkin-collector/scribe/src/main/**\n!zipkin-collector/pulsar/src/main/**\n!zipkin-junit5/src/main/**\n!zipkin-storage/src/main/**\n!zipkin-storage/cassandra/src/main/**\n!zipkin-storage/mysql-v1/src/main/**\n!zipkin-storage/elasticsearch/src/main/**\n!zipkin-server/src/main/**\n!zipkin-tests/src/main/**\n!zipkin-lens/javadoc/**\n!zipkin-lens/public/**\n!zipkin-lens/src/**\n!zipkin-lens/.linguirc\n!zipkin-lens/.npmrc\n!zipkin-lens/index.html\n!zipkin-lens/package-lock.json\n!zipkin-lens/package.json\n!zipkin-lens/pom.xml\n!zipkin-lens/tsconfig.json\n!zipkin-lens/vite.config.ts\n!**/pom.xml\n" }, { "path": ".editorconfig", "content": "root = true\n\n[*]\ncharset = utf-8\nend_of_line = lf\nindent_style = space\nindent_size = 2\ninsert_final_newline = true\ntrim_trailing_whitespace = true\n" }, { "path": ".gitattributes", "content": "*.java text=auto eol=lf\n*.bnd text=auto eol=lf\n\n*.sh text=auto eol=lf\n.*_profile text=auto eol=lf\n\n*.md text=auto eol=lf\n*.txt text=auto eol=lf\n\n*.yml text=auto eol=lf\n*.yaml text=auto eol=lf\n*.xml text=auto eol=lf\n*.properties text=auto eol=lf\n\n*.js text=auto eol=lf\n*.jsx text=auto eol=lf\n*.ts text=auto eol=lf\n*.tsx text=auto eol=lf\n*.json text=auto eol=lf\n*.mustache text=auto eol=lf\n*.css text=auto eol=lf\n" }, { "path": ".github/CONTRIBUTING.md", "content": "# Contributing to Zipkin\n\nIf you would like to contribute code, fork this GitHub repository and\nsend a pull request (on a branch other than `master` or `gh-pages`).\n\nWhen submitting code, please apply [Square Code Style](https://github.com/square/java-code-styles).\n* If the settings import correctly, CodeStyle/Java will be named Square and use 2 space tab and indent, with 4 space continuation indent.\n\n## License\n\nBy contributing your code, you agree to license your contribution under\nthe terms of the [APLv2](../LICENSE).\n\nAll files are released with the Apache 2.0 license.\n\nIf you are adding a new file it should have a header like below. This\ncan be automatically added by running `./mvnw com.mycila:license-maven-plugin:format`.\n\n```\n/*\n * Copyright The OpenZipkin Authors\n * SPDX-License-Identifier: Apache-2.0\n */\n ```\n" }, { "path": ".github/ISSUE_TEMPLATE/bug.md", "content": "---\nname: Bug\nabout: If you’ve found a bug, spend the time to write a failing test. Bugs with tests get fixed and stay fixed. If you have a solution in mind, skip raising an issue and open a pull request instead.\nlabels: bug\n---\n## Describe the Bug\nA clear and concise description of what the bug is. If you have a solution in mind, skip raising an issue and open a pull request instead.\n\nIf this is a UI issue...\n * Attach a screen shot or animated gif showing what you think is wrong\n * Include JSON of a trace that produces it, being careful to not include private data\n * You can literally include the JSON in [triple-backticks](https://help.github.com/en/github/writing-on-github/basic-writing-and-formatting-syntax#quoting-code)\n * Otherwise, you can use a [gist](https://gist.github.com/) or pastebin\n\nRegardless, the best is to spend some time to write a failing test. Bugs with tests get fixed and stay fixed.\n\n## Steps to Reproduce\nSteps to reproduce the behavior:\n\n## Expected Behaviour\nSuggest what you think correct behaviour should be. Note, it may be solved differently depending on the problem.\n" }, { "path": ".github/ISSUE_TEMPLATE/config.yml", "content": "blank_issues_enabled: false\ncontact_links:\n - name: Question\n url: https://gitter.im/openzipkin/zipkin\n about: Please ask questions about how to do something or to understand why something isn't working on our Gitter chat - we'll be happy to respond there in detail. This issue tracker is not for questions.\n" }, { "path": ".github/ISSUE_TEMPLATE/feature.md", "content": "---\nname: Feature Request\nabout: Please first, look at existing issues to see if the feature has been requested before.\nlabels: enhancement\n---\nPlease first, look at [existing issues](https://github.com/openzipkin/zipkin/issues) to see if the feature has been requested before. If you don't find anything tell us what problem you’re trying to solve. Often a solution already exists! Don’t send pull requests to implement new features without first getting our support. Sometimes we leave features out on purpose to keep the project small.\n\n## Feature\nDescription of the feature\n\n## Rationale\nWhy would this feature help others besides me?\n\n## Example Scenario\nWhat kind of use cases would benefit from this feature?\n\n## Prior Art\n* Links to prior art\n* More links\n" }, { "path": ".github/workflows/create_release.yml", "content": "---\nname: create_release\n\n# We create a release version on a trigger tag, regardless of if the commit is\n# documentation-only.\non: # yamllint disable-line rule:truthy\n push:\n tags: # e.g. release-1.2.3\n - 'release-[0-9]+.[0-9]+.[0-9]+**'\n\njobs:\n create_release:\n runs-on: ubuntu-24.04 # newest available distribution, aka noble\n steps:\n - name: Checkout Repository\n uses: actions/checkout@v4\n with:\n # Prevent use of implicit GitHub Actions read-only GITHUB_TOKEN\n # because maven-release-plugin pushes commits to master.\n token: ${{ secrets.GH_TOKEN }}\n - name: Setup java\n uses: actions/setup-java@v4\n with:\n distribution: 'zulu' # zulu as it supports a wide version range\n java-version: '17' # earliest LTS supported by Spring Boot 3\n - name: Cache local Maven repository\n uses: actions/cache@v4\n with:\n path: ~/.m2/repository\n key: ${{ runner.os }}-jdk-17-maven-${{ hashFiles('**/pom.xml') }}\n restore-keys: ${{ runner.os }}-jdk-17-maven-\n - name: Create Release\n env:\n # GH_USER=\n GH_USER: ${{ secrets.GH_USER }}\n # GH_TOKEN=\n # * makes release commits and tags\n # * needs repo:status, public_repo\n # * referenced in .settings.xml\n GH_TOKEN: ${{ secrets.GH_TOKEN }}\n run: | # GITHUB_REF will be refs/tags/release-MAJOR.MINOR.PATCH\n build-bin/git/login_git &&\n build-bin/maven/maven_release $(echo ${GITHUB_REF} | cut -d/ -f 3)\n" }, { "path": ".github/workflows/deploy.yml", "content": "# yamllint --format github .github/workflows/deploy.yml\n---\nname: deploy\n\n# We deploy on master and release versions, regardless of if the commit is\n# documentation-only or not.\non: # yamllint disable-line rule:truthy\n push:\n branches:\n - master\n # Don't deploy tags because the same commit for MAJOR.MINOR.PATCH is also\n # on master: Redundant deployment of a release version will fail uploading.\n tags-ignore:\n - '*'\n\njobs:\n deploy:\n runs-on: ubuntu-24.04 # newest available distribution, aka noble\n steps:\n - name: Checkout Repository\n uses: actions/checkout@v4\n with:\n # Prevent use of implicit GitHub Actions read-only GITHUB_TOKEN\n # because javadoc_to_gh_pages pushes commits to the gh-pages branch.\n token: ${{ secrets.GH_TOKEN }}\n # Allow build-bin/javadoc_to_gh_pages to fetch and push gh-pages\n # See https://github.com/actions/checkout/issues/578\n fetch-depth: 0\n - name: Setup java\n uses: actions/setup-java@v4\n with:\n distribution: 'zulu' # zulu as it supports a wide version range\n java-version: '17' # earliest LTS supported by Spring Boot 3\n - name: Cache local Maven repository\n uses: actions/cache@v4\n with:\n path: ~/.m2/repository\n key: ${{ runner.os }}-jdk-17-maven-${{ hashFiles('**/pom.xml') }}\n restore-keys: ${{ runner.os }}-jdk-17-maven-\n - name: Cache NPM Packages\n uses: actions/cache@v4\n with:\n path: ~/.npm\n # yamllint disable-line rule:line-length\n key: ${{ runner.os }}-npm-packages-${{ hashFiles('zipkin-lens/package-lock.json') }}\n # Don't attempt to cache Docker. Sensitive information can be stolen\n # via forks, and login session ends up in ~/.docker. This is ok because\n # we publish DOCKER_PARENT_IMAGE to ghcr.io, hence local to the runner.\n - name: Deploy\n env:\n # GH_USER=\n GH_USER: ${{ secrets.GH_USER }}\n # GH_TOKEN=\n # * pushes gh-pages during build-bin/javadoc_to_gh_pages\n # * pushes Docker images to ghcr.io\n # * create via https://github.com/settings/tokens\n # * needs repo:status, public_repo, write:packages, delete:packages\n GH_TOKEN: ${{ secrets.GH_TOKEN }}\n GPG_SIGNING_KEY: ${{ secrets.GPG_SIGNING_KEY }}\n # GPG_PASSPHRASE=\n # * referenced in .settings.xml\n GPG_PASSPHRASE: ${{ secrets.GPG_PASSPHRASE }}\n # SONATYPE_USER=\n # * deploys snapshots and releases to Sonatype\n # * needs access to io.zipkin via OSSRH-16669\n # * generate via https://oss.sonatype.org/#profile;User%20Token\n # * referenced in .settings.xml\n SONATYPE_USER: ${{ secrets.SONATYPE_USER }}\n # SONATYPE_PASSWORD=\n # * referenced in .settings.xml\n SONATYPE_PASSWORD: ${{ secrets.SONATYPE_PASSWORD }}\n # DOCKERHUB_USER=\n # * only push repos in openzipkin org to Docker Hub on release\n DOCKERHUB_USER: ${{ secrets.DOCKERHUB_USER }}\n # DOCKERHUB_TOKEN=\n # * Access Token from here https://hub.docker.com/settings/security\n DOCKERHUB_TOKEN: ${{ secrets.DOCKERHUB_TOKEN }}\n run: | # GITHUB_REF = refs/heads/master or refs/tags/MAJOR.MINOR.PATCH\n build-bin/configure_deploy &&\n build-bin/deploy $(echo ${GITHUB_REF} | cut -d/ -f 3)\n" }, { "path": ".github/workflows/docker_push.yml", "content": "---\nname: docker_push\n\n# We re-push docker on a trigger tag, regardless of if the commit is\n# documentation-only.\non: # yamllint disable-line rule:truthy\n push:\n tags: # e.g. docker-1.2.3\n - 'docker-[0-9]+.[0-9]+.[0-9]+**'\n\njobs:\n docker_push:\n runs-on: ubuntu-24.04 # newest available distribution, aka noble\n steps:\n - name: Checkout Repository\n uses: actions/checkout@v4\n # Don't attempt to cache Docker. Sensitive information can be stolen\n # via forks, and login session ends up in ~/.docker. This is ok because\n # we publish DOCKER_PARENT_IMAGE to ghcr.io, hence local to the runner.\n - name: Docker Push\n run: | # GITHUB_REF = refs/tags/docker-MAJOR.MINOR.PATCH\n build-bin/git/login_git &&\n build-bin/docker/configure_docker_push &&\n build-bin/docker_push $(echo ${GITHUB_REF} | cut -d/ -f 3)\n env:\n # GH_USER=\n GH_USER: ${{ secrets.GH_USER }}\n # GH_TOKEN=\n # * pushes Docker images to ghcr.io\n # * create via https://github.com/settings/tokens\n # * needs repo:status, public_repo, write:packages, delete:packages\n GH_TOKEN: ${{ secrets.GH_TOKEN }}\n # DOCKERHUB_USER=\n # * only push repos in openzipkin org to Docker Hub on release\n DOCKERHUB_USER: ${{ secrets.DOCKERHUB_USER }}\n # DOCKERHUB_TOKEN=\n # * Access Token from here https://hub.docker.com/settings/security\n DOCKERHUB_TOKEN: ${{ secrets.DOCKERHUB_TOKEN }}\n" }, { "path": ".github/workflows/lint.yml", "content": "---\nname: lint\n\non: # yamllint disable-line rule:truthy\n push: # non-tagged pushes to master\n branches:\n - master\n tags-ignore:\n - '*'\n paths:\n - '**/*.md'\n - '.github/workflows/*.yml'\n - './build-bin/*lint'\n - ./build-bin/mlc_config.json\n pull_request: # pull requests targeted at the master branch.\n branches:\n - master\n paths:\n - '**/*.md'\n - '.github/workflows/*.yml'\n - './build-bin/*lint'\n - ./build-bin/mlc_config.json\n\njobs:\n lint:\n name: lint\n runs-on: ubuntu-24.04 # newest available distribution, aka noble\n # skip commits made by the release plugin\n if: \"!contains(github.event.head_commit.message, 'maven-release-plugin')\"\n steps:\n - name: Checkout Repository\n uses: actions/checkout@v4\n - name: Lint\n run: |\n build-bin/configure_lint\n build-bin/lint\n" }, { "path": ".github/workflows/security.yml", "content": "---\nname: security\n\n# We don't scan documentation-only commits.\non: # yamllint disable-line rule:truthy\n push: # non-tagged pushes to master\n branches:\n - master\n tags-ignore:\n - '*'\n paths-ignore:\n - '**/*.md'\n - './build-bin/*lint'\n - ./build-bin/mlc_config.json\n pull_request: # pull requests targeted at the master branch.\n branches:\n - master\n paths-ignore:\n - '**/*.md'\n - './build-bin/*lint'\n - ./build-bin/mlc_config.json\n\njobs:\n security:\n name: security\n runs-on: ubuntu-24.04 # newest available distribution, aka numbat\n # skip commits made by the release plugin\n if: \"!contains(github.event.head_commit.message, 'maven-release-plugin')\"\n steps:\n - name: Checkout Repository\n uses: actions/checkout@v4\n - uses: actions/cache@v4\n name: Cache Trivy Database\n with:\n path: .trivy\n key: ${{ runner.os }}-trivy\n restore-keys: ${{ runner.os }}-trivy\n - name: Run Trivy vulnerability and secret scanner\n uses: aquasecurity/trivy-action@master\n id: trivy\n env: # See https://github.com/aquasecurity/trivy/discussions/7668\n TRIVY_DB_REPOSITORY: public.ecr.aws/aquasecurity/trivy-db\n TRIVY_JAVA_DB_REPOSITORY: public.ecr.aws/aquasecurity/trivy-java-db\n with:\n scan-type: 'fs'\n scan-ref: '.' # scan the entire repository\n scanners: vuln,secret\n exit-code: '1'\n severity: HIGH,CRITICAL\n output: trivy-report.md\n cache-dir: .trivy\n - name: Set Summary\n shell: bash\n if: ${{ failure() && steps.trivy.conclusion == 'failure' }}\n # Add the Trivy report to the summary\n #\n # Note: This will cause a workflow error if trivy-report.md > the step\n # limit 1MiB. If this was due to too many CVEs, consider fixing them ;)\n run: cat trivy-report.md >> $GITHUB_STEP_SUMMARY\n" }, { "path": ".github/workflows/test.yml", "content": "---\nname: test\n\n# We don't test documentation-only commits.\non: # yamllint disable-line rule:truthy\n push: # non-tagged pushes to master\n branches:\n - master\n tags-ignore:\n - '*'\n paths-ignore:\n - '**/*.md'\n - './build-bin/*lint'\n - ./build-bin/mlc_config.json\n pull_request: # pull requests targeted at the master branch.\n branches:\n - master\n paths-ignore:\n - '**/*.md'\n - './build-bin/*lint'\n - ./build-bin/mlc_config.json\n\njobs:\n test:\n name: test (JDK ${{ matrix.java_version }})\n runs-on: ubuntu-24.04 # newest available distribution, aka noble\n # skip commits made by the release plugin\n if: \"!contains(github.event.head_commit.message, 'maven-release-plugin')\"\n strategy:\n fail-fast: false # don't fail fast as some failures are LTS specific\n matrix: # match with maven-enforcer-plugin rules in pom.xml\n include:\n - java_version: 17 # earliest LTS supported by Spring Boot 3\n maven_args: -Prelease -Dgpg.skip\n - java_version: 21 # Most recent LTS\n steps:\n - name: Checkout Repository\n uses: actions/checkout@v4\n - name: Setup java\n uses: actions/setup-java@v4\n with:\n distribution: 'zulu' # zulu as it supports a wide version range\n java-version: ${{ matrix.java_version }}\n - name: Cache local Maven repository\n uses: actions/cache@v4\n with:\n path: ~/.m2/repository\n # yamllint disable-line rule:line-length\n key: ${{ runner.os }}-jdk-${{ matrix.java_version }}-maven-${{ hashFiles('**/pom.xml') }}\n restore-keys: ${{ runner.os }}-jdk-${{ matrix.java_version }}-maven-\n - name: Cache NPM Packages\n uses: actions/cache@v4\n with:\n path: ~/.npm\n # yamllint disable-line rule:line-length\n key: ${{ runner.os }}-npm-packages-${{ hashFiles('zipkin-lens/package-lock.json') }}\n - name: Test without Docker\n run: |\n build-bin/maven_go_offline &&\n build-bin/test -DexcludedGroups=docker ${{ matrix.maven_args }}\n\n test_docker:\n runs-on: ubuntu-24.04 # newest available distribution, aka noble\n # skip commits made by the release plugin\n if: \"!contains(github.event.head_commit.message, 'maven-release-plugin')\"\n strategy:\n matrix:\n include:\n - name: zipkin-collector-activemq\n - name: zipkin-collector-kafka\n - name: zipkin-collector-rabbitmq\n - name: zipkin-collector-pulsar\n - name: zipkin-storage-cassandra\n - name: zipkin-storage-elasticsearch\n - name: zipkin-storage-mysql-v1\n - name: zipkin-server\n steps:\n - name: Checkout Repository\n uses: actions/checkout@v4\n - name: Setup java\n uses: actions/setup-java@v4\n with:\n distribution: 'zulu' # zulu as it supports a wide version range\n java-version: '21' # Most recent LTS\n - name: Cache local Maven repository\n uses: actions/cache@v4\n with:\n path: ~/.m2/repository\n # yamllint disable-line rule:line-length\n key: ${{ runner.os }}-jdk-${{ matrix.java_version }}-maven-${{ hashFiles('**/pom.xml') }}\n restore-keys: ${{ runner.os }}-jdk-${{ matrix.java_version }}-maven-\n # Don't attempt to cache Docker. Sensitive information can be stolen\n # via forks, and login session ends up in ~/.docker. This is ok because\n # we publish DOCKER_PARENT_IMAGE to ghcr.io, hence local to the runner.\n - name: Test with Docker\n # configure_test seeds NPM cache, which isn't needed for these tests.\n #\n # What we are doing here is configuring docker, then installing the\n # module's dependencies prior to testing it with docker. This allows\n # us to avoid running tests except the leaf module.\n run: |\n build-bin/docker/configure_docker &&\n build-bin/maven/maven_go_offline &&\n build-bin/maven/maven_build -pl :${{ matrix.name }} --am &&\n build-bin/test -Dgroups=docker -pl :${{ matrix.name }}\n env:\n MAVEN_GOAL: install # docker build needs dependencies in mavenLocal\n MAVEN_CONFIG: '-Dlicense.skip=true' # license check already run\n" }, { "path": ".github/workflows/test_readme.yml", "content": "---\nname: test_readme\n\n# These test build commands mentioned in various README.md files.\n#\n# We don't test documentation-only commits.\non: # yamllint disable-line rule:truthy\n push: # non-tagged pushes to master\n branches:\n - master\n tags-ignore:\n - '*'\n paths-ignore:\n - '**/*.md'\n - './build-bin/*lint'\n - ./build-bin/mlc_config.json\n pull_request: # pull requests targeted at the master branch.\n branches:\n - master\n paths-ignore:\n - '**/*.md'\n - './build-bin/*lint'\n - ./build-bin/mlc_config.json\n\njobs:\n zipkin-server:\n name: zipkin-server/README.md ${{ matrix.name }}\n runs-on: ${{ matrix.os }}\n # skip commits made by the release plugin\n if: \"!contains(github.event.head_commit.message, 'maven-release-plugin')\"\n timeout-minutes: 5\n strategy:\n matrix:\n include: # Not ubuntu as already tested as a part of the docker job\n - name: macos\n os: macos-14\n - name: windows\n os: windows-2022\n steps:\n - name: Checkout Repository\n uses: actions/checkout@v4\n - name: Setup java\n uses: actions/setup-java@v4\n with:\n distribution: 'zulu' # zulu as it supports a wide version range\n java-version: '21' # Most recent LTS\n cache: 'maven'\n - name: Cache NPM Packages\n uses: actions/cache@v4\n with:\n path: ~/.npm\n # yamllint disable-line rule:line-length\n key: ${{ runner.os }}-npm-packages-${{ hashFiles('zipkin-lens/package-lock.json') }}\n - name: Execute Server Build # command from zipkin-server/README.md\n run: ./mvnw --also-make -pl zipkin-server clean package\n env:\n MAVEN_CONFIG: '-T1C -q --batch-mode -DskipTests'\n\n docker:\n runs-on: ubuntu-24.04 # newest available distribution, aka noble\n # skip commits made by the release plugin\n if: \"!contains(github.event.head_commit.message, 'maven-release-plugin')\"\n timeout-minutes: 20\n steps:\n - name: Checkout Repository\n uses: actions/checkout@v4\n # Remove apt repos that are known to break from time to time.\n # See https://github.com/actions/virtual-environments/issues/323\n - name: Remove broken apt repos\n run: |\n for apt_file in `grep -lr microsoft /etc/apt/sources.list.d/`\n do sudo rm $apt_file\n done\n - name: Setup java\n uses: actions/setup-java@v4\n with:\n distribution: 'zulu' # zulu as it supports a wide version range\n java-version: '21' # Most recent LTS\n cache: 'maven'\n # Don't attempt to cache Docker. Sensitive information can be stolen\n # via forks, and login session ends up in ~/.docker. This is ok because\n # we publish DOCKER_PARENT_IMAGE to ghcr.io, hence local to the runner.\n - name: Cache NPM Packages\n uses: actions/cache@v4\n with:\n path: ~/.npm\n # yamllint disable-line rule:line-length\n key: ${{ runner.os }}-npm-packages-${{ hashFiles('zipkin-lens/package-lock.json') }}\n - name: Build zipkin-server # redundant, but needed for docker/README.md\n run: ./mvnw --also-make -pl zipkin-server clean package\n env:\n MAVEN_CONFIG: '-T1C -q --batch-mode -DskipTests'\n - name: docker/README.md - openzipkin/zipkin\n run: |\n build-bin/docker/docker_build openzipkin/zipkin:test &&\n build-bin/docker/docker_test_image openzipkin/zipkin:test &&\n docker run --rm --entrypoint=/bin/sh openzipkin/zipkin:test \\\n -c 'cd BOOT-INF/lib && du -sk *aarch* *x86* *a64*' || true\n env:\n RELEASE_FROM_MAVEN_BUILD: true\n - name: docker/README.md - openzipkin/zipkin-slim\n run: |\n build-bin/docker/docker_build openzipkin/zipkin-slim:test &&\n build-bin/docker/docker_test_image openzipkin/zipkin-slim:test &&\n docker run --rm --entrypoint=/bin/sh openzipkin/zipkin-slim:test \\\n -c 'cd BOOT-INF/lib && du -sk *aarch* *x86* *a64*' || true\n env:\n DOCKER_TARGET: zipkin-slim\n RELEASE_FROM_MAVEN_BUILD: true\n - name: docker/test-images/zipkin-ui/README.md\n run: |\n build-bin/docker/docker_build ${DOCKER_TAG} &&\n build-bin/docker/docker_test_image ${DOCKER_TAG}\n env:\n DOCKER_TAG: openzipkin/zipkin-ui:test\n DOCKER_FILE: docker/test-images/zipkin-ui/Dockerfile\n RELEASE_FROM_MAVEN_BUILD: true\n - name: docker/test-images/zipkin-uiproxy/README.md\n run: |\n build-bin/docker/docker_build ${DOCKER_TAG} &&\n build-bin/docker/docker_test_image ${DOCKER_TAG}\n env:\n DOCKER_TAG: openzipkin/zipkin-uiproxy:test\n DOCKER_FILE: docker/test-images/zipkin-uiproxy/Dockerfile\n - name: docker/test-images/zipkin-activemq/README.md\n run: |\n build-bin/docker/docker_build ${DOCKER_TAG} &&\n build-bin/docker/docker_test_image ${DOCKER_TAG}\n env:\n DOCKER_TAG: openzipkin/zipkin-activemq:test\n DOCKER_FILE: docker/test-images/zipkin-activemq/Dockerfile\n - name: docker/test-images/zipkin-cassandra/README.md\n run: |\n build-bin/docker/docker_build ${DOCKER_TAG} &&\n build-bin/docker/docker_test_image ${DOCKER_TAG}\n env:\n DOCKER_TAG: openzipkin/zipkin-cassandra:test\n DOCKER_FILE: docker/test-images/zipkin-cassandra/Dockerfile\n - name: docker/test-images/zipkin-elasticsearch7/README.md\n run: |\n build-bin/docker/docker_build ${DOCKER_TAG} &&\n build-bin/docker/docker_test_image ${DOCKER_TAG}\n env:\n DOCKER_TAG: openzipkin/zipkin-elasticsearch7:test\n DOCKER_FILE: docker/test-images/zipkin-elasticsearch7/Dockerfile\n - name: docker/test-images/zipkin-elasticsearch8/README.md\n run: |\n build-bin/docker/docker_build ${DOCKER_TAG} &&\n build-bin/docker/docker_test_image ${DOCKER_TAG}\n env:\n DOCKER_TAG: openzipkin/zipkin-elasticsearch8:test\n DOCKER_FILE: docker/test-images/zipkin-elasticsearch8/Dockerfile\n - name: docker/test-images/zipkin-opensearch2/README.md\n run: |\n build-bin/docker/docker_build ${DOCKER_TAG} &&\n build-bin/docker/docker_test_image ${DOCKER_TAG}\n env:\n DOCKER_TAG: openzipkin/zipkin-opensearch2:test\n DOCKER_FILE: docker/test-images/zipkin-opensearch2/Dockerfile\n - name: docker/test-images/zipkin-eureka/README.md\n run: |\n build-bin/docker/docker_build openzipkin/zipkin-eureka:test &&\n build-bin/docker/docker_test_image openzipkin/zipkin-eureka:test\n env:\n DOCKER_FILE: docker/test-images/zipkin-eureka/Dockerfile\n - name: docker/test-images/zipkin-kafka/README.md\n run: |\n build-bin/docker/docker_build openzipkin/zipkin-kafka:test &&\n build-bin/docker/docker_test_image openzipkin/zipkin-kafka:test\n env:\n DOCKER_FILE: docker/test-images/zipkin-kafka/Dockerfile\n - name: docker/test-images/zipkin-mysql/README.md\n run: |\n build-bin/docker/docker_build openzipkin/zipkin-mysql:test &&\n build-bin/docker/docker_test_image openzipkin/zipkin-mysql:test\n env:\n DOCKER_FILE: docker/test-images/zipkin-mysql/Dockerfile\n - name: docker/test-images/zipkin-rabbitmq/README.md\n run: |\n build-bin/docker/docker_build openzipkin/zipkin-rabbitmq:test &&\n build-bin/docker/docker_test_image openzipkin/zipkin-rabbitmq:test\n env:\n DOCKER_FILE: docker/test-images/zipkin-rabbitmq/Dockerfile\n - name: docker/test-images/zipkin-pulsar/README.md\n run: |\n build-bin/docker/docker_build openzipkin/zipkin-pulsar:test &&\n build-bin/docker/docker_test_image openzipkin/zipkin-pulsar:test\n env:\n DOCKER_FILE: docker/test-images/zipkin-pulsar/Dockerfile\n" }, { "path": ".gitignore", "content": "*~\n#*\n*#\n.#*\ndependency-reduced-pom.xml\n.factorypath\n.classpath\n.project\n.settings/\n.springBeans\ntarget/\n_site/\n.idea\n*.iml\n*.swp\n# quickstart or temporary copies of zipkin's jar\n/*.jar\n# temporary directory used by build-bin/javadoc_to_gh_pages for building gh-pages\n/javadoc-builddir\n.DS_Store\n\n# This project does not use Gradle but some developers may use it to e.g., setup a Node environment.\n# It doesn't hurt to just exclude it here.\n.gradle\n\n# This project does not use Yarn but some developers may use it to e.g., start zipkin-lens dev server.\n# It doesn't hurt to just exclude it here.\nyarn.lock\n" }, { "path": ".mvn/wrapper/maven-wrapper.properties", "content": "# Licensed to the Apache Software Foundation (ASF) under one\n# or more contributor license agreements. See the NOTICE file\n# distributed with this work for additional information\n# regarding copyright ownership. The ASF licenses this file\n# to you under the Apache License, Version 2.0 (the\n# \"License\"); you may not use this file except in compliance\n# with the License. You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing,\n# software distributed under the License is distributed on an\n# \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY\n# KIND, either express or implied. See the License for the\n# specific language governing permissions and limitations\n# under the License.\nwrapperVersion=3.3.2\ndistributionType=bin\ndistributionUrl=https://repo.maven.apache.org/maven2/org/apache/maven/apache-maven/3.9.9/apache-maven-3.9.9-bin.zip\nwrapperUrl=https://repo.maven.apache.org/maven2/org/apache/maven/wrapper/maven-wrapper/3.3.2/maven-wrapper-3.3.2.jar\n" }, { "path": ".settings.xml", "content": "\n\n\n \n \n gpg.passphrase\n ${env.GPG_PASSPHRASE}\n \n \n ossrh\n ${env.SONATYPE_USER}\n ${env.SONATYPE_PASSWORD}\n \n \n github.com\n zipkinci\n ${env.GH_TOKEN}\n \n \n\n" }, { "path": "LICENSE", "content": " Apache License\n Version 2.0, January 2004\n http://www.apache.org/licenses/\n\n TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION\n\n 1. Definitions.\n\n \"License\" shall mean the terms and conditions for use, reproduction,\n and distribution as defined by Sections 1 through 9 of this document.\n\n \"Licensor\" shall mean the copyright owner or entity authorized by\n the copyright owner that is granting the License.\n\n \"Legal Entity\" shall mean the union of the acting entity and all\n other entities that control, are controlled by, or are under common\n control with that entity. For the purposes of this definition,\n \"control\" means (i) the power, direct or indirect, to cause the\n direction or management of such entity, whether by contract or\n otherwise, or (ii) ownership of fifty percent (50%) or more of the\n outstanding shares, or (iii) beneficial ownership of such entity.\n\n \"You\" (or \"Your\") shall mean an individual or Legal Entity\n exercising permissions granted by this License.\n\n \"Source\" form shall mean the preferred form for making modifications,\n including but not limited to software source code, documentation\n source, and configuration files.\n\n \"Object\" form shall mean any form resulting from mechanical\n transformation or translation of a Source form, including but\n not limited to compiled object code, generated documentation,\n and conversions to other media types.\n\n \"Work\" shall mean the work of authorship, whether in Source or\n Object form, made available under the License, as indicated by a\n copyright notice that is included in or attached to the work\n (an example is provided in the Appendix below).\n\n \"Derivative Works\" shall mean any work, whether in Source or Object\n form, that is based on (or derived from) the Work and for which the\n editorial revisions, annotations, elaborations, or other modifications\n represent, as a whole, an original work of authorship. For the purposes\n of this License, Derivative Works shall not include works that remain\n separable from, or merely link (or bind by name) to the interfaces of,\n the Work and Derivative Works thereof.\n\n \"Contribution\" shall mean any work of authorship, including\n the original version of the Work and any modifications or additions\n to that Work or Derivative Works thereof, that is intentionally\n submitted to Licensor for inclusion in the Work by the copyright owner\n or by an individual or Legal Entity authorized to submit on behalf of\n the copyright owner. For the purposes of this definition, \"submitted\"\n means any form of electronic, verbal, or written communication sent\n to the Licensor or its representatives, including but not limited to\n communication on electronic mailing lists, source code control systems,\n and issue tracking systems that are managed by, or on behalf of, the\n Licensor for the purpose of discussing and improving the Work, but\n excluding communication that is conspicuously marked or otherwise\n designated in writing by the copyright owner as \"Not a Contribution.\"\n\n \"Contributor\" shall mean Licensor and any individual or Legal Entity\n on behalf of whom a Contribution has been received by Licensor and\n subsequently incorporated within the Work.\n\n 2. Grant of Copyright License. Subject to the terms and conditions of\n this License, each Contributor hereby grants to You a perpetual,\n worldwide, non-exclusive, no-charge, royalty-free, irrevocable\n copyright license to reproduce, prepare Derivative Works of,\n publicly display, publicly perform, sublicense, and distribute the\n Work and such Derivative Works in Source or Object form.\n\n 3. Grant of Patent License. Subject to the terms and conditions of\n this License, each Contributor hereby grants to You a perpetual,\n worldwide, non-exclusive, no-charge, royalty-free, irrevocable\n (except as stated in this section) patent license to make, have made,\n use, offer to sell, sell, import, and otherwise transfer the Work,\n where such license applies only to those patent claims licensable\n by such Contributor that are necessarily infringed by their\n Contribution(s) alone or by combination of their Contribution(s)\n with the Work to which such Contribution(s) was submitted. If You\n institute patent litigation against any entity (including a\n cross-claim or counterclaim in a lawsuit) alleging that the Work\n or a Contribution incorporated within the Work constitutes direct\n or contributory patent infringement, then any patent licenses\n granted to You under this License for that Work shall terminate\n as of the date such litigation is filed.\n\n 4. Redistribution. You may reproduce and distribute copies of the\n Work or Derivative Works thereof in any medium, with or without\n modifications, and in Source or Object form, provided that You\n meet the following conditions:\n\n (a) You must give any other recipients of the Work or\n Derivative Works a copy of this License; and\n\n (b) You must cause any modified files to carry prominent notices\n stating that You changed the files; and\n\n (c) You must retain, in the Source form of any Derivative Works\n that You distribute, all copyright, patent, trademark, and\n attribution notices from the Source form of the Work,\n excluding those notices that do not pertain to any part of\n the Derivative Works; and\n\n (d) If the Work includes a \"NOTICE\" text file as part of its\n distribution, then any Derivative Works that You distribute must\n include a readable copy of the attribution notices contained\n within such NOTICE file, excluding those notices that do not\n pertain to any part of the Derivative Works, in at least one\n of the following places: within a NOTICE text file distributed\n as part of the Derivative Works; within the Source form or\n documentation, if provided along with the Derivative Works; or,\n within a display generated by the Derivative Works, if and\n wherever such third-party notices normally appear. The contents\n of the NOTICE file are for informational purposes only and\n do not modify the License. You may add Your own attribution\n notices within Derivative Works that You distribute, alongside\n or as an addendum to the NOTICE text from the Work, provided\n that such additional attribution notices cannot be construed\n as modifying the License.\n\n You may add Your own copyright statement to Your modifications and\n may provide additional or different license terms and conditions\n for use, reproduction, or distribution of Your modifications, or\n for any such Derivative Works as a whole, provided Your use,\n reproduction, and distribution of the Work otherwise complies with\n the conditions stated in this License.\n\n 5. Submission of Contributions. Unless You explicitly state otherwise,\n any Contribution intentionally submitted for inclusion in the Work\n by You to the Licensor shall be under the terms and conditions of\n this License, without any additional terms or conditions.\n Notwithstanding the above, nothing herein shall supersede or modify\n the terms of any separate license agreement you may have executed\n with Licensor regarding such Contributions.\n\n 6. Trademarks. This License does not grant permission to use the trade\n names, trademarks, service marks, or product names of the Licensor,\n except as required for reasonable and customary use in describing the\n origin of the Work and reproducing the content of the NOTICE file.\n\n 7. Disclaimer of Warranty. Unless required by applicable law or\n agreed to in writing, Licensor provides the Work (and each\n Contributor provides its Contributions) on an \"AS IS\" BASIS,\n WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or\n implied, including, without limitation, any warranties or conditions\n of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A\n PARTICULAR PURPOSE. You are solely responsible for determining the\n appropriateness of using or redistributing the Work and assume any\n risks associated with Your exercise of permissions under this License.\n\n 8. Limitation of Liability. In no event and under no legal theory,\n whether in tort (including negligence), contract, or otherwise,\n unless required by applicable law (such as deliberate and grossly\n negligent acts) or agreed to in writing, shall any Contributor be\n liable to You for damages, including any direct, indirect, special,\n incidental, or consequential damages of any character arising as a\n result of this License or out of the use or inability to use the\n Work (including but not limited to damages for loss of goodwill,\n work stoppage, computer failure or malfunction, or any and all\n other commercial damages or losses), even if such Contributor\n has been advised of the possibility of such damages.\n\n 9. Accepting Warranty or Additional Liability. While redistributing\n the Work or Derivative Works thereof, You may choose to offer,\n and charge a fee for, acceptance of support, warranty, indemnity,\n or other liability obligations and/or rights consistent with this\n License. However, in accepting such obligations, You may act only\n on Your own behalf and on Your sole responsibility, not on behalf\n of any other Contributor, and only if You agree to indemnify,\n defend, and hold each Contributor harmless for any liability\n incurred by, or claims asserted against, such Contributor by reason\n of your accepting any such warranty or additional liability.\n\n END OF TERMS AND CONDITIONS\n\n APPENDIX: How to apply the Apache License to your work.\n\n To apply the Apache License to your work, attach the following\n boilerplate notice, with the fields enclosed by brackets \"{}\"\n replaced with your own identifying information. (Don't include\n the brackets!) The text should be enclosed in the appropriate\n comment syntax for the file format. We also recommend that a\n file or class name and description of purpose be included on the\n same \"printed page\" as the copyright notice for easier\n identification within third-party archives.\n\n Copyright {yyyy} {name of copyright owner}\n\n Licensed under the Apache License, Version 2.0 (the \"License\");\n you may not use this file except in compliance with the License.\n You may obtain a copy of the License at\n\n http://www.apache.org/licenses/LICENSE-2.0\n\n Unless required by applicable law or agreed to in writing, software\n distributed under the License is distributed on an \"AS IS\" BASIS,\n WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n See the License for the specific language governing permissions and\n limitations under the License.\n\nThis product contains a modified part of Gson, distributed by Google:\n\n * License: Apache License v2.0\n * Homepage: https://github.com/google/gson\n\nThis product contains a modified part of Guava, distributed by Google:\n\n * License: Apache License v2.0\n * Homepage: https://github.com/google/guava\n\nThis product contains a modified part of Okio, distributed by Square:\n\n * License: Apache License v2.0\n * Homepage: https://github.com/square/okio\n" }, { "path": "README.md", "content": "# zipkin\n\n[![Gitter chat](http://img.shields.io/badge/gitter-join%20chat%20%E2%86%92-brightgreen.svg)](https://gitter.im/openzipkin/zipkin)\n[![Build Status](https://github.com/openzipkin/zipkin/actions/workflows/test.yml/badge.svg?branch=master)](https://github.com/openzipkin/zipkin/actions?query=workflow%3Atest+branch%3Amaster)\n[![Maven Central](https://img.shields.io/maven-central/v/io.zipkin/zipkin-server.svg)](https://central.sonatype.com/search?q=zipkin&namespace=io.zipkin&name=zipkin-server)\n\n[Zipkin](https://zipkin.io) is a distributed tracing system. It helps gather\ntiming data needed to troubleshoot latency problems in service architectures.\nFeatures include both the collection and lookup of this data.\n\nIf you have a trace ID in a log file, you can jump directly to it. Otherwise,\nyou can query based on attributes such as service, operation name, tags and\nduration. Some interesting data will be summarized for you, such as the\npercentage of time spent in a service, and whether operations failed.\n\n\"Trace\n\nThe Zipkin UI also presents a dependency diagram showing how many traced\nrequests went through each application. This can be helpful for identifying\naggregate behavior including error paths or calls to deprecated services.\n\n\"Dependency\n\nApplication’s need to be “instrumented” to report trace data to Zipkin. This\nusually means configuration of a [tracer or instrumentation library](https://zipkin.io/pages/tracers_instrumentation.html). The most\npopular ways to report data to Zipkin are via http or Kafka, though many other\noptions exist, such as Apache ActiveMQ, gRPC, RabbitMQ and Apache Pulsar. The data served to\nthe UI is stored in-memory, or persistently with a supported backend such as\nApache Cassandra or Elasticsearch.\n\n## Quick-start\n\nThe quickest way to get started is to fetch the [latest released server](https://central.sonatype.com/search?q=zipkin&namespace=io.zipkin&name=zipkin-server&sort=published) as a self-contained\nexecutable jar. Note that the Zipkin server requires minimum JRE 17+. For example:\n\n```bash\ncurl -sSL https://zipkin.io/quickstart.sh | bash -s\njava -jar zipkin.jar\n```\n\nYou can also start Zipkin via Docker.\n```bash\n# Note: this is mirrored as ghcr.io/openzipkin/zipkin\ndocker run -d -p 9411:9411 openzipkin/zipkin\n```\n\nOnce the server is running, you can view traces with the Zipkin UI at http://localhost:9411/zipkin.\n\nIf your applications aren't sending traces, yet, configure them with [Zipkin instrumentation](https://zipkin.io/pages/tracers_instrumentation) or try one of our [examples](https://github.com/openzipkin?utf8=%E2%9C%93&q=example).\n\nCheck out the [`zipkin-server`](zipkin-server/README.md) documentation for configuration details, or [Docker examples](docker/examples) for how to use docker-compose.\n\n### Zipkin Slim\n\nThe slim build of Zipkin is smaller and starts faster. It supports in-memory and Elasticsearch storage, but doesn't support messaging transports like Kafka or RabbitMQ. If these constraints match your needs, you can try slim like below:\n\nRunning via Java:\n```bash\ncurl -sSL https://zipkin.io/quickstart.sh | bash -s io.zipkin:zipkin-server:LATEST:slim zipkin.jar\njava -jar zipkin.jar\n```\n\nRunning via Docker:\n```bash\n# Note: this is mirrored as ghcr.io/openzipkin/zipkin-slim\ndocker run -d -p 9411:9411 openzipkin/zipkin-slim\n```\n\nRunning via [Homebrew](https://formulae.brew.sh/formula/zipkin):\n```bash\nbrew install zipkin\n# to run in foreground\nzipkin\n# to run in background\nbrew services start zipkin\n```\n\n## Core Library\nThe [core library](zipkin/src/main/java/zipkin2) is used by both Zipkin instrumentation and the Zipkin server.\n\nThis includes built-in codec for Zipkin's v1 and v2 json formats. A direct dependency on gson\n(json library) is avoided by minifying and repackaging classes used. The result is a 155k jar which\nwon't conflict with any library you use.\n\nEx.\n```java\n// All data are recorded against the same endpoint, associated with your service graph\nlocalEndpoint = Endpoint.newBuilder().serviceName(\"tweetie\").ip(\"192.168.0.1\").build()\nspan = Span.newBuilder()\n .traceId(\"d3d200866a77cc59\")\n .id(\"d3d200866a77cc59\")\n .name(\"targz\")\n .localEndpoint(localEndpoint)\n .timestamp(epochMicros())\n .duration(durationInMicros)\n .putTag(\"compression.level\", \"9\");\n\n// Now, you can encode it as json\nbytes = SpanBytesEncoder.JSON_V2.encode(span);\n```\n\nNote: The above is just an example, most likely you'll want to use an existing tracing library like [Brave](https://github.com/openzipkin/brave)\n\n### Core Library Requires Java 8+\n\nThe minimum Java language level of the core library is 8. This helps support those writing agent\ninstrumentation. Version 2.x was the last to support Java 6.\n\n*Note*: [zipkin-reporter-brave](https://github.com/openzipkin/zipkin-reporter-java/blob/master/brave/README.md)\ndoes not use this library. So, [brave](https://github.com/openzipkin/brave) still supports Java 6.\n\n## Storage Component\nZipkin includes a [StorageComponent](zipkin/src/main/java/zipkin2/storage/StorageComponent.java), used to store and query spans and\ndependency links. This is used by the server and those making collectors, or span reporters.\nFor this reason, storage components have minimal dependencies, though require Java 17+.\n\nEx.\n```java\n// this won't create network connections\nstorage = ElasticsearchStorage.newBuilder()\n .hosts(asList(\"http://myelastic:9200\")).build();\n\n// prepare a call\ntraceCall = storage.spanStore().getTrace(\"d3d200866a77cc59\");\n\n// execute it synchronously or asynchronously\ntrace = traceCall.execute();\n\n// clean up any sessions, etc\nstorage.close();\n```\n\n### In-Memory\nThe [InMemoryStorage](zipkin-server#in-memory-storage) component is packaged in zipkin's core library. It\nis neither persistent, nor viable for realistic work loads. Its purpose\nis for testing, for example starting a server on your laptop without any\ndatabase needed.\n\n### Cassandra\nThe [Cassandra](zipkin-server#cassandra-storage) component uses Cassandra\n3.11.3+ features, but is tested against the latest patch of Cassandra 4.1.\n\nThis is the second generation of our Cassandra schema. It stores spans\nusing UDTs, such that they appear like Zipkin v2 json in cqlsh. It is\ndesigned for scale, and uses a combination of SASI and manually\nimplemented indexes to make querying larger data more performant.\n\nNote: This store requires a [job to aggregate](https://github.com/openzipkin/zipkin-dependencies) dependency links.\n\n### Elasticsearch\nThe [Elasticsearch](zipkin-server#elasticsearch-storage) component uses\nElasticsearch 5+ features, but is tested against Elasticsearch 7-8.x and\nOpenSearch 2.x.\n\nIt stores spans as Zipkin v2 json so that integration with other tools is\nstraightforward. To help with scale, this uses a combination of custom\nand manually implemented indexing.\n\nNote: This store requires a [spark job](https://github.com/openzipkin/zipkin-dependencies) to aggregate dependency links.\n\n### Disabling search\nThe following API endpoints provide search features, and are enabled by\ndefault. Search primarily allows the trace list screen of the UI operate.\n* `GET /services` - Distinct Span.localServiceName\n* `GET /remoteServices?serviceName=X` - Distinct Span.remoteServiceName by Span.localServiceName\n* `GET /spans?serviceName=X` - Distinct Span.name by Span.localServiceName\n* `GET /autocompleteKeys` - Distinct keys of Span.tags subject to configurable whitelist\n* `GET /autocompleteValues?key=X` - Distinct values of Span.tags by key\n* `GET /traces` - Traces matching a query possibly including the above criteria\n\n\nWhen search is disabled, traces can only be retrieved by ID\n(`GET /trace/{traceId}`). Disabling search is only viable when there is\nan alternative way to find trace IDs, such as logs. Disabling search can\nreduce storage costs or increase write throughput.\n\n`StorageComponent.Builder.searchEnabled(false)` is implied when a zipkin\nis run with the env variable `SEARCH_ENABLED=false`.\n\n### Legacy (v1) components\nThe following components are no longer encouraged, but exist to help aid\ntransition to supported ones. These are indicated as \"v1\" as they use\ndata layouts based on Zipkin's V1 Thrift model, as opposed to the\nsimpler v2 data model currently used.\n\n#### MySQL\nThe [MySQL v1](zipkin-storage/mysql-v1) component uses MySQL 5.6+\nfeatures, but is tested against MariaDB 10.11.\n\nThe schema was designed to be easy to understand and get started with;\nit was not designed for performance. Ex spans fields are columns, so\nyou can perform ad-hoc queries using SQL. However, this component has\n[known performance issues](https://github.com/openzipkin/zipkin/issues/1233): queries will eventually take seconds to return\nif you put a lot of data into it.\n\nThis store does not require a [job to aggregate](https://github.com/openzipkin/zipkin-dependencies) dependency links.\nHowever, running the job will improve performance of dependencies\nqueries.\n\n## Running the server from source\nThe [Zipkin server](zipkin-server) receives spans via HTTP POST and respond to queries\nfrom its UI. It can also run collectors, such as RabbitMQ or Kafka.\n\nTo run the server from the currently checked out source, enter the\nfollowing. JDK 17+ is required to compile the source.\n```bash\n# Build the server and also make its dependencies\n$ ./mvnw -q --batch-mode -DskipTests --also-make -pl zipkin-server clean install\n# Run the server\n$ java -jar ./zipkin-server/target/zipkin-server-*exec.jar\n```\n\n## Artifacts\nServer artifacts are under the maven group id `io.zipkin`\nLibrary artifacts are under the maven group id `io.zipkin.zipkin2`\n\n### Library Releases\nReleases are at [Sonatype](https://oss.sonatype.org/content/repositories/releases) and [Maven Central](http://search.maven.org/#search%7Cga%7C1%7Cg%3A%22io.zipkin%22)\n\n### Library Snapshots\nSnapshots are uploaded to [Sonatype](https://oss.sonatype.org/content/repositories/snapshots) after\ncommits to master.\n\n### Docker Images\nReleased versions of zipkin-server are published to Docker Hub as `openzipkin/zipkin` and GitHub\nContainer Registry as `ghcr.io/openzipkin/zipkin`. See [docker](docker) for details.\n\n### Helm Charts\nHelm charts are available via `helm repo add zipkin https://zipkin.io/zipkin-helm`.\nSee [zipkin-helm](https://github.com/openzipkin/zipkin-helm) for details.\n\n### Javadocs\nhttps://zipkin.io/zipkin contains versioned folders with JavaDocs published on each (non-PR) build, as well\nas releases.\n" }, { "path": "RELEASE.md", "content": "# OpenZipkin Release Process\n\nThis repo uses semantic versions. Please keep this in mind when choosing version numbers.\n\n1. **Verify all dependencies are up-to-date**\n\n Before you start a release, make sure all dependencies are up-to-date, or are documented why not.\n Pay special attention to the [security workflow](.github/workflows/security.yml), which should\n run clean.\n\n1. **Alert others you are releasing**\n\n There should be no commits made to master while the release is in progress (about 10 minutes). Before you start\n a release, alert others on [gitter](https://gitter.im/openzipkin/zipkin) so that they don't accidentally merge\n anything. If they do, and the build fails because of that, you'll have to recreate the release tag described below.\n\n1. **Push a git tag**\n\n The trigger format is `release-MAJOR.MINOR.PATCH`, ex `git tag release-1.18.1 && git push origin release-1.18.1`.\n\n1. **Wait for CI**\n\n The `release-MAJOR.MINOR.PATCH` tag triggers [`build-bin/maven/maven_release`](build-bin/maven/maven_release),\n which creates commits, `MAJOR.MINOR.PATCH` tag, and increments the version (maven-release-plugin).\n\n The `MAJOR.MINOR.PATCH` tag triggers [`build-bin/deploy`](build-bin/deploy), which does the following:\n * Publishes jars to https://oss.sonatype.org/content/repositories/releases [`build-bin/maven/maven_deploy`](build-bin/maven/maven_deploy)\n * Later, the same jars synchronize to Maven Central\n * Publishes Javadoc to https://zipkin.io/brave into a versioned subdirectory\n * Pushes images to Docker registries [`build-bin/docker_push`](build-bin/docker_push)\n\n Notes:\n * https://search.maven.org/ index will take longer than direct links like https://repo1.maven.org/maven2/io/zipkin\n\n## Credentials\n\nThe release process uses various credentials. If you notice something failing due to unauthorized,\nlook at the notes in [.github/workflows/deploy.yml] and check the [org secrets](https://github.com/organizations/openzipkin/settings/secrets/actions).\n\n### Troubleshooting invalid credentials\n\nIf you receive a '401 unauthorized' failure from OSSRH, it is likely\n`SONATYPE_USER` or `SONATYPE_PASSWORD` entries are invalid, or possibly the\nuser associated with them does not have rights to upload.\n\nThe least destructive test is to try to publish a snapshot manually. By passing\nthe values CI would use, you can kick off a snapshot from your laptop. This\nis a good way to validate that your unencrypted credentials are authorized.\n\nHere's an example of a snapshot deploy with specified credentials.\n```bash\n$ export GPG_TTY=$(tty) && GPG_PASSPHRASE=whackamole SONATYPE_USER=adrianmole SONATYPE_PASSWORD=ed6f20bde9123bbb2312b221 build-bin/build-bin/maven/maven_deploy\n```\n\n## Manually releasing\n\nIf for some reason, you lost access to CI or otherwise cannot get automation to work, bear in mind\nthis is a normal maven project, and can be released accordingly.\n\n*Note:* If [Sonatype is down](https://status.sonatype.com/), the below will not work.\n\n```bash\n# First, set variable according to your personal credentials. These would normally be assigned as\n# org secrets: https://github.com/organizations/openzipkin/settings/secrets/actions\nexport GPG_TTY=$(tty)\nexport GPG_PASSPHRASE=your_gpg_passphrase\nexport SONATYPE_USER=your_sonatype_account\nexport SONATYPE_PASSWORD=your_sonatype_password\nrelease_version=xx-version-to-release-xx\n\n# now from latest master, create the release. This creates and pushes the MAJOR.MINOR.PATCH tag\n./build-bin/maven/maven_release release-${release_version}\n\n# once this works, deploy the release\ngit checkout ${release_version}\n./build-bin/deploy\n\n# Finally, clean up\n./mvnw release:clean\ngit checkout master\ngit reset HEAD --hard\n```\n" }, { "path": "SECURITY.md", "content": "# OpenZipkin Security Process\n\nThis document outlines the process for handling security concerns in OpenZipkin projects.\n\nAny vulnerability or misconfiguration detected in our [security workflow](.github/workflows/security.yml)\nshould be addressed as a normal pull request.\n\nOpenZipkin is a volunteer community and does not have a dedicated security team. There may be\nperiods where no volunteer is able to address a security concern. There is no SLA or warranty\noffered by volunteers. If you are a security researcher, please consider this before escalating.\n\nFor security concerns that are sensitive or otherwise outside the scope of public issues, please\ncontact zipkin-admin@googlegroups.com.\n" }, { "path": "benchmarks/README.md", "content": "# zipkin-benchmarks\n\nThis module includes [JMH](http://openjdk.java.net/projects/code-tools/jmh/)\nbenchmarks for zipkin. You can use these to measure overhead.\n\n### Running the benchmark\nFrom the project directory, run this to build the benchmarks:\n\n```bash\n$ ./mvnw install -pl benchmarks -am -Dmaven.test.skip.exec=true\n```\n\nand the following to run them:\n\n```bash\n$ java -jar benchmarks/target/benchmarks.jar\n```\n" }, { "path": "benchmarks/pom.xml", "content": "\n\n\n 4.0.0\n\n \n io.zipkin\n zipkin-parent\n 3.6.0-SNAPSHOT\n \n\n benchmarks\n Benchmarks\n Benchmarks (JMH)\n\n \n ${project.basedir}/..\n\n 17\n 17\n 17\n\n 1.37\n ${project.build.directory}/main/proto\n \n\n \n \n \n \n io.netty\n netty-bom\n ${netty.version}\n pom\n import\n \n\n \n com.fasterxml.jackson\n jackson-bom\n ${jackson.version}\n pom\n import\n \n \n \n\n \n \n \n \n com.squareup.wire\n wire-runtime-jvm\n ${wire.version}\n provided\n \n \n io.zipkin.proto3\n zipkin-proto3\n ${zipkin-proto3.version}\n provided\n \n\n \n org.openjdk.jmh\n jmh-core\n ${jmh.version}\n test\n \n \n \n org.openjdk.jmh\n jmh-generator-annprocess\n ${jmh.version}\n test\n \n \n \n com.google.code.gson\n gson\n ${gson.version}\n test\n \n \n com.squareup.moshi\n moshi\n 1.15.2\n \n \n \n com.squareup.okio\n okio\n \n \n test\n \n\n \n com.esotericsoftware\n kryo\n ${kryo.version}\n test\n \n\n \n com.google.protobuf\n protobuf-java\n 3.25.8\n test\n \n\n \n \n ${project.groupId}\n zipkin-server\n ${project.version}\n \n \n org.slf4j\n *\n \n \n org.springframework.boot\n spring-boot-starter-log4j2\n \n \n test\n \n \n org.slf4j\n slf4j-simple\n ${slf4j.version}\n test\n \n \n org.slf4j\n jul-to-slf4j\n ${slf4j.version}\n \n\n \n ${project.groupId}.zipkin2\n zipkin-storage-elasticsearch\n ${project.version}\n test\n \n \n ${project.groupId}.zipkin2\n zipkin-tests\n ${project.version}\n test\n \n\n \n \n ${project.groupId}.zipkin2\n zipkin-storage-cassandra\n ${project.version}\n \n \n io.netty\n *\n \n \n test\n \n \n org.apache.cassandra\n java-driver-core\n ${java-driver.version}\n test\n \n \n io.netty\n *\n \n \n \n \n ${project.groupId}.zipkin2\n zipkin-storage-mysql-v1\n ${project.version}\n test\n \n \n org.mariadb.jdbc\n mariadb-java-client\n ${mariadb-java-client.version}\n test\n \n \n com.zaxxer\n HikariCP\n ${HikariCP.version}\n test\n \n \n org.testcontainers\n testcontainers\n ${testcontainers.version}\n test\n \n \n\n \n \n \n \n maven-assembly-plugin\n ${maven-assembly-plugin.version}\n \n \n src/test/assembly/test-jar.xml\n \n \n \n \n make-assembly\n package\n \n single\n \n \n true\n benchmarks\n false\n \n \n org.openjdk.jmh.Main\n \n \n \n \n \n \n \n maven-compiler-plugin\n \n \n default-compile\n compile\n \n compile\n \n \n \n javac\n \n \n \n \n \n test-compile\n test-compile\n \n testCompile\n \n \n \n javac\n \n \n \n \n org.openjdk.jmh\n jmh-generator-annprocess\n ${jmh.version}\n \n \n \n \n \n \n \n maven-dependency-plugin\n \n \n de.m3y.maven\n wire-maven-plugin\n \n ${generated-proto.directory}\n \n \n \n \n\n" }, { "path": "benchmarks/src/test/assembly/test-jar.xml", "content": "\n\n \n test-jar\n \n jar\n \n false\n \n \n /\n true\n true\n test\n \n \n \n \n ${project.build.directory}/test-classes\n /\n \n **/*\n \n true\n \n \n\n" }, { "path": "benchmarks/src/test/java/zipkin2/EndpointBenchmarks.java", "content": "/*\n * Copyright The OpenZipkin Authors\n * SPDX-License-Identifier: Apache-2.0\n */\npackage zipkin2;\n\nimport java.net.Inet4Address;\nimport java.net.Inet6Address;\nimport java.net.InetAddress;\nimport java.net.UnknownHostException;\nimport java.util.concurrent.TimeUnit;\nimport org.openjdk.jmh.annotations.Benchmark;\nimport org.openjdk.jmh.annotations.BenchmarkMode;\nimport org.openjdk.jmh.annotations.Fork;\nimport org.openjdk.jmh.annotations.Measurement;\nimport org.openjdk.jmh.annotations.Mode;\nimport org.openjdk.jmh.annotations.OutputTimeUnit;\nimport org.openjdk.jmh.annotations.Scope;\nimport org.openjdk.jmh.annotations.State;\nimport org.openjdk.jmh.annotations.Threads;\nimport org.openjdk.jmh.annotations.Warmup;\nimport org.openjdk.jmh.runner.Runner;\nimport org.openjdk.jmh.runner.RunnerException;\nimport org.openjdk.jmh.runner.options.Options;\nimport org.openjdk.jmh.runner.options.OptionsBuilder;\n\n@Measurement(iterations = 5, time = 1)\n@Warmup(iterations = 10, time = 1)\n@Fork(3)\n@BenchmarkMode(Mode.SampleTime)\n@OutputTimeUnit(TimeUnit.MICROSECONDS)\n@State(Scope.Thread)\n@Threads(2)\npublic class EndpointBenchmarks {\n static final String IPV4 = \"43.0.192.2\", IPV6 = \"2001:db8::c001\";\n static final InetAddress IPV4_ADDR, IPV6_ADDR;\n\n static {\n try {\n IPV4_ADDR = Inet4Address.getByName(IPV4);\n IPV6_ADDR = Inet6Address.getByName(IPV6);\n } catch (UnknownHostException e) {\n throw new AssertionError(e);\n }\n }\n\n Endpoint.Builder builder = Endpoint.newBuilder();\n\n @Benchmark public boolean parseIpv4_literal() {\n return builder.parseIp(IPV4);\n }\n\n @Benchmark public boolean parseIpv4_addr() {\n return builder.parseIp(IPV4_ADDR);\n }\n\n @Benchmark public boolean parseIpv4_bytes() {\n return builder.parseIp(IPV4_ADDR.getAddress());\n }\n\n @Benchmark public boolean parseIpv6_literal() {\n return builder.parseIp(IPV6);\n }\n\n @Benchmark public boolean parseIpv6_addr() {\n return builder.parseIp(IPV6_ADDR);\n }\n\n @Benchmark public boolean parseIpv6_bytes() {\n return builder.parseIp(IPV6_ADDR.getAddress());\n }\n\n // Convenience main entry-point\n public static void main(String[] args) throws RunnerException {\n Options opt = new OptionsBuilder()\n .addProfiler(\"gc\")\n .include(\".*\" + EndpointBenchmarks.class.getSimpleName())\n .build();\n\n new Runner(opt).run();\n }\n}\n" }, { "path": "benchmarks/src/test/java/zipkin2/SpanBenchmarks.java", "content": "/*\n * Copyright The OpenZipkin Authors\n * SPDX-License-Identifier: Apache-2.0\n */\npackage zipkin2;\n\nimport com.esotericsoftware.kryo.Kryo;\nimport com.esotericsoftware.kryo.io.Input;\nimport com.esotericsoftware.kryo.io.Output;\nimport com.esotericsoftware.kryo.serializers.JavaSerializer;\nimport java.util.concurrent.TimeUnit;\nimport org.openjdk.jmh.annotations.Benchmark;\nimport org.openjdk.jmh.annotations.BenchmarkMode;\nimport org.openjdk.jmh.annotations.Fork;\nimport org.openjdk.jmh.annotations.Measurement;\nimport org.openjdk.jmh.annotations.Mode;\nimport org.openjdk.jmh.annotations.OutputTimeUnit;\nimport org.openjdk.jmh.annotations.Scope;\nimport org.openjdk.jmh.annotations.State;\nimport org.openjdk.jmh.annotations.Threads;\nimport org.openjdk.jmh.annotations.Warmup;\nimport org.openjdk.jmh.runner.Runner;\nimport org.openjdk.jmh.runner.RunnerException;\nimport org.openjdk.jmh.runner.options.Options;\nimport org.openjdk.jmh.runner.options.OptionsBuilder;\n\nimport static zipkin2.internal.HexCodec.lowerHexToUnsignedLong;\n\n@Measurement(iterations = 5, time = 1)\n@Warmup(iterations = 10, time = 1)\n@Fork(3)\n@BenchmarkMode(Mode.SampleTime)\n@OutputTimeUnit(TimeUnit.MICROSECONDS)\n@State(Scope.Thread)\n@Threads(2)\npublic class SpanBenchmarks {\n static final Endpoint FRONTEND =\n Endpoint.newBuilder().serviceName(\"frontend\").ip(\"127.0.0.1\").build();\n static final Endpoint BACKEND =\n Endpoint.newBuilder().serviceName(\"backend\").ip(\"192.168.99.101\").port(9000).build();\n static final Span clientSpan = buildClientSpan(Span.newBuilder());\n\n final Span.Builder sharedBuilder;\n\n public SpanBenchmarks() {\n sharedBuilder = buildClientSpan().toBuilder();\n }\n\n static final String traceIdHex = \"86154a4ba6e91385\", spanIdHex = \"4d1e00c0db9010db\";\n static final long traceId = lowerHexToUnsignedLong(traceIdHex);\n static final long spanId = lowerHexToUnsignedLong(spanIdHex);\n\n @Benchmark\n public Span buildClientSpan() {\n return buildClientSpan(Span.newBuilder());\n }\n\n @Benchmark\n public Span buildClientSpan_longs() {\n return buildClientSpan_longs(Span.newBuilder());\n }\n\n static Span buildClientSpan(Span.Builder builder) {\n return builder\n .traceId(traceIdHex)\n .parentId(traceIdHex)\n .id(spanIdHex)\n .name(\"get\")\n .kind(Span.Kind.CLIENT)\n .localEndpoint(FRONTEND)\n .remoteEndpoint(BACKEND)\n .timestamp(1472470996199000L)\n .duration(207000L)\n .addAnnotation(1472470996238000L, \"ws\")\n .addAnnotation(1472470996403000L, \"wr\")\n .putTag(\"http.path\", \"/api\")\n .putTag(\"clnt/finagle.version\", \"6.45.0\")\n .build();\n }\n\n static Span buildClientSpan_longs(Span.Builder builder) {\n return builder\n .traceId(0L, traceId)\n .parentId(traceId)\n .id(spanId)\n .name(\"get\")\n .kind(Span.Kind.CLIENT)\n .localEndpoint(FRONTEND)\n .remoteEndpoint(BACKEND)\n .timestamp(1472470996199000L)\n .duration(207000L)\n .addAnnotation(1472470996238000L, \"ws\")\n .addAnnotation(1472470996403000L, \"wr\")\n .putTag(\"http.path\", \"/api\")\n .putTag(\"clnt/finagle.version\", \"6.45.0\")\n .build();\n }\n\n @Benchmark\n public Span buildClientSpan_clear() {\n return buildClientSpan(sharedBuilder.clear());\n }\n\n @Benchmark\n public Span buildClientSpan_clone() {\n return sharedBuilder.clone().build();\n }\n\n static final Kryo kryo = new Kryo();\n static final byte[] clientSpanSerialized;\n\n static {\n kryo.register(Span.class, new JavaSerializer());\n Output output = new Output(4096);\n kryo.writeObject(output, clientSpan);\n output.flush();\n clientSpanSerialized = output.getBuffer();\n }\n\n /** manually implemented with json so not as slow as normal java */\n @Benchmark\n public Span serialize_kryo() {\n return kryo.readObject(new Input(clientSpanSerialized), Span.class);\n }\n\n @Benchmark\n public byte[] deserialize_kryo() {\n Output output = new Output(clientSpanSerialized.length);\n kryo.writeObject(output, clientSpan);\n output.flush();\n return output.getBuffer();\n }\n\n @Benchmark\n public String padLeft_1Char() {\n return Span.padLeft(\"1\", 16);\n }\n\n @Benchmark\n public String padLeft_15Chars() {\n return Span.padLeft(\"123456789012345\", 16);\n }\n\n @Benchmark\n public String padLeft_17Chars() {\n return Span.padLeft(\"12345678901234567\", 32);\n }\n\n @Benchmark\n public String padLeft_31Chars() {\n return Span.padLeft(\"1234567890123456789012345678901\", 32);\n }\n\n // Convenience main entry-point\n public static void main(String[] args) throws RunnerException {\n Options opt = new OptionsBuilder()\n .include(\".*\" + SpanBenchmarks.class.getSimpleName() + \".*\")\n .addProfiler(\"gc\")\n .build();\n\n new Runner(opt).run();\n }\n}\n" }, { "path": "benchmarks/src/test/java/zipkin2/codec/CodecBenchmarks.java", "content": "/*\n * Copyright The OpenZipkin Authors\n * SPDX-License-Identifier: Apache-2.0\n */\npackage zipkin2.codec;\n\nimport java.util.Collections;\nimport java.util.List;\nimport java.util.concurrent.TimeUnit;\nimport org.openjdk.jmh.annotations.Benchmark;\nimport org.openjdk.jmh.annotations.BenchmarkMode;\nimport org.openjdk.jmh.annotations.Fork;\nimport org.openjdk.jmh.annotations.Measurement;\nimport org.openjdk.jmh.annotations.Mode;\nimport org.openjdk.jmh.annotations.OutputTimeUnit;\nimport org.openjdk.jmh.annotations.Scope;\nimport org.openjdk.jmh.annotations.State;\nimport org.openjdk.jmh.annotations.Threads;\nimport org.openjdk.jmh.annotations.Warmup;\nimport org.openjdk.jmh.runner.Runner;\nimport org.openjdk.jmh.runner.RunnerException;\nimport org.openjdk.jmh.runner.options.Options;\nimport org.openjdk.jmh.runner.options.OptionsBuilder;\nimport zipkin2.Span;\n\nimport static java.nio.charset.StandardCharsets.UTF_8;\nimport static zipkin2.storage.cassandra.internal.Resources.resourceToString;\n\n/**\n * The {@link SpanBytesEncoder bundled java codec} aims to be both small in size (i.e. does not\n * significantly increase the size of zipkin's jar), and efficient. It may not always be fastest,\n * but we should try to keep it competitive.\n *\n *

Note that the wire benchmarks use their structs, not ours. This will result in more efficient\n * writes as there's no hex codec of IDs, stringifying of IPs etc. A later change could do that, but\n * it likely still going to be more efficient than our dependency-free codec. This means in cases\n * where extra dependencies are ok (such as our server), we could consider using wire.\n */\n@Measurement(iterations = 5, time = 1)\n@Warmup(iterations = 10, time = 1)\n@Fork(3)\n@BenchmarkMode(Mode.SampleTime)\n@OutputTimeUnit(TimeUnit.MICROSECONDS)\n@State(Scope.Thread)\n@Threads(1)\npublic class CodecBenchmarks {\n static final byte[] clientSpanJsonV2 = resourceToString(\"/zipkin2-client.json\").getBytes(UTF_8);\n static final Span clientSpan = SpanBytesDecoder.JSON_V2.decodeOne(clientSpanJsonV2);\n static final byte[] clientSpanJsonV1 = SpanBytesEncoder.JSON_V1.encode(clientSpan);\n static final byte[] clientSpanProto3 = SpanBytesEncoder.PROTO3.encode(clientSpan);\n static final byte[] clientSpanThrift = SpanBytesEncoder.THRIFT.encode(clientSpan);\n static final List tenClientSpans = Collections.nCopies(10, clientSpan);\n static final byte[] tenClientSpansJsonV2 = SpanBytesEncoder.JSON_V2.encodeList(tenClientSpans);\n\n @Benchmark\n public Span decodeClientSpan_JSON_V1() {\n return SpanBytesDecoder.JSON_V1.decodeOne(clientSpanJsonV1);\n }\n\n @Benchmark\n public Span decodeClientSpan_JSON_V2() {\n return SpanBytesDecoder.JSON_V2.decodeOne(clientSpanJsonV2);\n }\n\n @Benchmark\n public Span decodeClientSpan_PROTO3() {\n return SpanBytesDecoder.PROTO3.decodeOne(clientSpanProto3);\n }\n\n @Benchmark\n public Span decodeClientSpan_THRIFT() {\n return SpanBytesDecoder.THRIFT.decodeOne(clientSpanThrift);\n }\n\n @Benchmark\n public int sizeInBytesClientSpan_JSON_V2() {\n return SpanBytesEncoder.JSON_V2.sizeInBytes(clientSpan);\n }\n\n @Benchmark\n public int sizeInBytesClientSpan_JSON_V1() {\n return SpanBytesEncoder.JSON_V1.sizeInBytes(clientSpan);\n }\n\n @Benchmark\n public int sizeInBytesClientSpan_PROTO3() {\n return SpanBytesEncoder.PROTO3.sizeInBytes(clientSpan);\n }\n\n @Benchmark\n public int sizeInBytesClientSpan_THRIFT() {\n return SpanBytesEncoder.THRIFT.sizeInBytes(clientSpan);\n }\n\n @Benchmark\n public byte[] writeClientSpan_JSON_V2() {\n return SpanBytesEncoder.JSON_V2.encode(clientSpan);\n }\n\n @Benchmark\n public byte[] writeClientSpan_JSON_V1() {\n return SpanBytesEncoder.JSON_V1.encode(clientSpan);\n }\n\n @Benchmark\n public byte[] writeClientSpan_PROTO3() {\n return SpanBytesEncoder.PROTO3.encode(clientSpan);\n }\n\n @Benchmark\n public byte[] writeClientSpan_THRIFT() {\n return SpanBytesEncoder.THRIFT.encode(clientSpan);\n }\n\n @Benchmark\n public List decodeTenClientSpans_JSON_V2() {\n return SpanBytesDecoder.JSON_V2.decodeList(tenClientSpansJsonV2);\n }\n\n @Benchmark\n public byte[] writeTenClientSpans_JSON_V2() {\n return SpanBytesEncoder.JSON_V2.encodeList(tenClientSpans);\n }\n\n static final byte[] chineseSpanJsonV2 = resourceToString(\"/zipkin2-chinese.json\").getBytes(UTF_8);\n static final Span chineseSpan = SpanBytesDecoder.JSON_V2.decodeOne(chineseSpanJsonV2);\n static final byte[] chineseSpanProto3 = SpanBytesEncoder.PROTO3.encode(chineseSpan);\n static final byte[] chineseSpanJsonV1 = SpanBytesEncoder.JSON_V1.encode(chineseSpan);\n static final byte[] chineseSpanThrift = SpanBytesEncoder.THRIFT.encode(chineseSpan);\n\n @Benchmark\n public Span decodeChineseSpan_JSON_V1() {\n return SpanBytesDecoder.JSON_V1.decodeOne(chineseSpanJsonV1);\n }\n\n @Benchmark\n public Span decodeChineseSpan_JSON_V2() {\n return SpanBytesDecoder.JSON_V2.decodeOne(chineseSpanJsonV2);\n }\n\n @Benchmark\n public Span decodeChineseSpan_PROTO3() {\n return SpanBytesDecoder.PROTO3.decodeOne(chineseSpanProto3);\n }\n\n @Benchmark\n public Span decodeChineseSpan_THRIFT() {\n return SpanBytesDecoder.THRIFT.decodeOne(chineseSpanThrift);\n }\n\n @Benchmark\n public byte[] writeChineseSpan_JSON_V2() {\n return SpanBytesEncoder.JSON_V2.encode(chineseSpan);\n }\n\n @Benchmark\n public byte[] writeChineseSpan_JSON_V1() {\n return SpanBytesEncoder.JSON_V1.encode(chineseSpan);\n }\n\n @Benchmark\n public byte[] writeChineseSpan_PROTO3() {\n return SpanBytesEncoder.PROTO3.encode(chineseSpan);\n }\n\n @Benchmark\n public byte[] writeChineseSpan_THRIFT() {\n return SpanBytesEncoder.THRIFT.encode(chineseSpan);\n }\n\n // Convenience main entry-point\n public static void main(String[] args) throws RunnerException {\n Options opt = new OptionsBuilder()\n .addProfiler(\"gc\")\n .include(\".*\" + CodecBenchmarks.class.getSimpleName())\n .build();\n\n new Runner(opt).run();\n }\n}\n" }, { "path": "benchmarks/src/test/java/zipkin2/codec/JacksonSpanDecoder.java", "content": "/*\n * Copyright The OpenZipkin Authors\n * SPDX-License-Identifier: Apache-2.0\n */\npackage zipkin2.codec;\n\nimport com.fasterxml.jackson.core.JsonFactory;\nimport com.fasterxml.jackson.core.JsonParser;\nimport com.fasterxml.jackson.core.JsonToken;\nimport java.io.IOException;\nimport java.io.UncheckedIOException;\nimport java.nio.ByteBuffer;\nimport java.util.ArrayList;\nimport java.util.List;\nimport zipkin2.Annotation;\nimport zipkin2.Endpoint;\nimport zipkin2.Span;\nimport zipkin2.internal.ReadBuffer;\n\npublic final class JacksonSpanDecoder {\n\n static final JsonFactory JSON_FACTORY = new JsonFactory();\n\n public static List decodeList(byte[] spans) {\n try {\n return decodeList(JSON_FACTORY.createParser(spans));\n } catch (IOException e) {\n throw new UncheckedIOException(e);\n }\n }\n\n public static List decodeList(ByteBuffer spans) {\n try {\n return decodeList(JSON_FACTORY.createParser(ReadBuffer.wrapUnsafe(spans)));\n } catch (IOException e) {\n throw new UncheckedIOException(e);\n }\n }\n\n public static Span decodeOne(byte[] span) {\n try {\n return decodeOne(JSON_FACTORY.createParser(span));\n } catch (IOException e) {\n throw new UncheckedIOException(e);\n }\n }\n\n public static Span decodeOne(ByteBuffer span) {\n try {\n return decodeOne(JSON_FACTORY.createParser(ReadBuffer.wrapUnsafe(span)));\n } catch (IOException e) {\n throw new UncheckedIOException(e);\n }\n }\n\n static List decodeList(JsonParser jsonParser) {\n List out = new ArrayList<>();\n\n try {\n if (jsonParser.nextToken() != JsonToken.START_ARRAY) {\n throw new IOException(\"Not a valid JSON array, start token: \" + jsonParser.currentToken());\n }\n\n while (jsonParser.nextToken() != JsonToken.END_ARRAY) {\n out.add(parseSpan(jsonParser));\n }\n } catch (IOException e) {\n throw new UncheckedIOException(e);\n }\n\n return out;\n }\n\n static Span decodeOne(JsonParser jsonParser) {\n try {\n if (!jsonParser.hasCurrentToken()) {\n jsonParser.nextToken();\n }\n return parseSpan(jsonParser);\n } catch (IOException e) {\n throw new UncheckedIOException(e);\n }\n }\n\n static Span parseSpan(JsonParser jsonParser) throws IOException {\n if (!jsonParser.isExpectedStartObjectToken()) {\n throw new IOException(\"Not a valid JSON object, start token: \" +\n jsonParser.currentToken());\n }\n\n Span.Builder result = Span.newBuilder();\n\n while (jsonParser.nextToken() != JsonToken.END_OBJECT) {\n String fieldName = jsonParser.currentName();\n JsonToken value = jsonParser.nextToken();\n if (value == JsonToken.VALUE_NULL) {\n continue;\n }\n switch (fieldName) {\n case \"traceId\":\n result.traceId(jsonParser.getValueAsString());\n break;\n case \"parentId\":\n result.parentId(jsonParser.getValueAsString());\n break;\n case \"id\":\n result.id(jsonParser.getValueAsString());\n break;\n case \"kind\":\n result.kind(Span.Kind.valueOf(jsonParser.getValueAsString()));\n break;\n case \"name\":\n result.name(jsonParser.getValueAsString());\n break;\n case \"timestamp\":\n result.timestamp(jsonParser.getValueAsLong());\n break;\n case \"duration\":\n result.duration(jsonParser.getValueAsLong());\n break;\n case \"localEndpoint\":\n result.localEndpoint(parseEndpoint(jsonParser));\n break;\n case \"remoteEndpoint\":\n result.remoteEndpoint(parseEndpoint(jsonParser));\n break;\n case \"annotations\":\n if (!jsonParser.isExpectedStartArrayToken()) {\n throw new IOException(\"Invalid span, expecting annotations array start, got: \" +\n value);\n }\n while (jsonParser.nextToken() != JsonToken.END_ARRAY) {\n Annotation a = parseAnnotation(jsonParser);\n result.addAnnotation(a.timestamp(), a.value());\n }\n break;\n case \"tags\":\n if (value != JsonToken.START_OBJECT) {\n throw new IOException(\"Invalid span, expecting tags object, got: \" + value);\n }\n while (jsonParser.nextToken() != JsonToken.END_OBJECT) {\n result.putTag(jsonParser.currentName(), jsonParser.nextTextValue());\n }\n break;\n case \"debug\":\n result.debug(jsonParser.getBooleanValue());\n break;\n case \"shared\":\n result.shared(jsonParser.getBooleanValue());\n break;\n default:\n jsonParser.skipChildren();\n }\n }\n\n return result.build();\n }\n\n static Endpoint parseEndpoint(JsonParser jsonParser) throws IOException {\n if (!jsonParser.isExpectedStartObjectToken()) {\n throw new IOException(\"Not a valid JSON object, start token: \" +\n jsonParser.currentToken());\n }\n\n String serviceName = null, ipv4 = null, ipv6 = null;\n int port = 0;\n\n while (jsonParser.nextToken() != JsonToken.END_OBJECT) {\n String fieldName = jsonParser.currentName();\n JsonToken value = jsonParser.nextToken();\n if (value == JsonToken.VALUE_NULL) {\n continue;\n }\n\n switch (fieldName) {\n case \"serviceName\":\n serviceName = jsonParser.getValueAsString();\n break;\n case \"ipv4\":\n ipv4 = jsonParser.getValueAsString();\n break;\n case \"ipv6\":\n ipv6 = jsonParser.getValueAsString();\n break;\n case \"port\":\n port = jsonParser.getValueAsInt();\n break;\n default:\n jsonParser.skipChildren();\n }\n }\n\n if (serviceName == null && ipv4 == null && ipv6 == null && port == 0) return null;\n return Endpoint.newBuilder()\n .serviceName(serviceName)\n .ip(ipv4)\n .ip(ipv6)\n .port(port)\n .build();\n }\n\n static Annotation parseAnnotation(JsonParser jsonParser) throws IOException {\n if (!jsonParser.isExpectedStartObjectToken()) {\n throw new IOException(\"Not a valid JSON object, start token: \" +\n jsonParser.currentToken());\n }\n\n long timestamp = 0;\n String value = null;\n\n while (jsonParser.nextToken() != JsonToken.END_OBJECT) {\n String fieldName = jsonParser.currentName();\n\n switch (fieldName) {\n case \"timestamp\":\n timestamp = jsonParser.getValueAsLong();\n break;\n case \"value\":\n value = jsonParser.getValueAsString();\n break;\n default:\n jsonParser.skipChildren();\n }\n }\n\n if (timestamp == 0 || value == null) {\n throw new IllegalStateException(\"Incomplete annotation at \" + jsonParser.currentToken());\n }\n return Annotation.create(timestamp, value);\n }\n}\n" }, { "path": "benchmarks/src/test/java/zipkin2/codec/JacksonSpanDecoderTest.java", "content": "/*\n * Copyright The OpenZipkin Authors\n * SPDX-License-Identifier: Apache-2.0\n */\npackage zipkin2.codec;\n\nimport io.netty.buffer.ByteBuf;\nimport io.netty.buffer.PooledByteBufAllocator;\nimport org.junit.jupiter.api.Test;\n\nimport static org.assertj.core.api.Assertions.assertThat;\nimport static zipkin2.TestObjects.CLIENT_SPAN;\nimport static zipkin2.TestObjects.TRACE;\n\npublic class JacksonSpanDecoderTest {\n byte[] encoded = SpanBytesEncoder.JSON_V2.encodeList(TRACE);\n byte[] encodedSpan = SpanBytesEncoder.JSON_V2.encode(CLIENT_SPAN);\n\n @Test void decodeList_bytes() {\n assertThat(JacksonSpanDecoder.decodeList(encoded))\n .isEqualTo(TRACE);\n }\n\n @Test void decodeList_byteBuffer() {\n ByteBuf encodedBuf = PooledByteBufAllocator.DEFAULT.buffer(encoded.length);\n encodedBuf.writeBytes(encoded);\n try {\n assertThat(JacksonSpanDecoder.decodeList(encodedBuf.nioBuffer()))\n .isEqualTo(TRACE);\n } finally {\n encodedBuf.release();\n }\n }\n\n @Test void decodeOne() {\n assertThat(JacksonSpanDecoder.decodeOne(encodedSpan))\n .isEqualTo(CLIENT_SPAN);\n }\n\n @Test void decodeOne_byteBuffer() {\n ByteBuf encodedBuf = PooledByteBufAllocator.DEFAULT.buffer(encodedSpan.length);\n encodedBuf.writeBytes(encodedSpan);\n try {\n assertThat(JacksonSpanDecoder.decodeOne(encodedBuf.nioBuffer()))\n .isEqualTo(CLIENT_SPAN);\n } finally {\n encodedBuf.release();\n }\n }\n}\n" }, { "path": "benchmarks/src/test/java/zipkin2/codec/JsonCodecBenchmarks.java", "content": "/*\n * Copyright The OpenZipkin Authors\n * SPDX-License-Identifier: Apache-2.0\n */\npackage zipkin2.codec;\n\nimport io.netty.buffer.ByteBuf;\nimport io.netty.buffer.PooledByteBufAllocator;\nimport java.util.Collections;\nimport java.util.List;\nimport java.util.concurrent.TimeUnit;\nimport org.openjdk.jmh.annotations.Benchmark;\nimport org.openjdk.jmh.annotations.BenchmarkMode;\nimport org.openjdk.jmh.annotations.Fork;\nimport org.openjdk.jmh.annotations.Measurement;\nimport org.openjdk.jmh.annotations.Mode;\nimport org.openjdk.jmh.annotations.OutputTimeUnit;\nimport org.openjdk.jmh.annotations.Scope;\nimport org.openjdk.jmh.annotations.Setup;\nimport org.openjdk.jmh.annotations.State;\nimport org.openjdk.jmh.annotations.TearDown;\nimport org.openjdk.jmh.annotations.Threads;\nimport org.openjdk.jmh.annotations.Warmup;\nimport org.openjdk.jmh.runner.Runner;\nimport org.openjdk.jmh.runner.options.Options;\nimport org.openjdk.jmh.runner.options.OptionsBuilder;\nimport zipkin2.Span;\n\nimport static java.nio.charset.StandardCharsets.UTF_8;\nimport static zipkin2.storage.cassandra.internal.Resources.resourceToString;\n\n@Measurement(iterations = 5, time = 1)\n@Warmup(iterations = 10, time = 1)\n@Fork(3)\n@BenchmarkMode(Mode.SampleTime)\n@OutputTimeUnit(TimeUnit.MICROSECONDS)\n@State(Scope.Thread)\n@Threads(1)\npublic class JsonCodecBenchmarks {\n static final MoshiSpanDecoder MOSHI = MoshiSpanDecoder.create();\n\n static final byte[] clientSpanJsonV2 = resourceToString(\"/zipkin2-client.json\").getBytes(UTF_8);\n static final Span clientSpan = SpanBytesDecoder.JSON_V2.decodeOne(clientSpanJsonV2);\n\n // Assume a message is 1000 spans (which is a high number for as this is per-node-second)\n static final List spans = Collections.nCopies(1000, clientSpan);\n static final byte[] encodedBytes = SpanBytesEncoder.JSON_V2.encodeList(spans);\n\n private ByteBuf encodedBuf;\n\n @Setup public void setup() {\n encodedBuf = PooledByteBufAllocator.DEFAULT.buffer(encodedBytes.length);\n encodedBuf.writeBytes(encodedBytes);\n }\n\n @TearDown public void tearDown() {\n encodedBuf.release();\n }\n\n @Benchmark public List bytes_jacksonDecoder() {\n return JacksonSpanDecoder.decodeList(encodedBytes);\n }\n\n @Benchmark public List bytes_moshiDecoder() {\n return MOSHI.decodeList(encodedBytes);\n }\n\n @Benchmark public List bytes_zipkinDecoder() {\n return SpanBytesDecoder.JSON_V2.decodeList(encodedBytes);\n }\n\n @Benchmark public List bytebuffer_jacksonDecoder() {\n return JacksonSpanDecoder.decodeList(encodedBuf.nioBuffer());\n }\n\n @Benchmark public List bytebuffer_moshiDecoder() {\n return MOSHI.decodeList(encodedBuf.nioBuffer());\n }\n\n @Benchmark public List bytebuffer_zipkinDecoder() {\n return SpanBytesDecoder.JSON_V2.decodeList(encodedBuf.nioBuffer());\n }\n\n // Convenience main entry-point\n public static void main(String[] args) throws Exception {\n Options opt = new OptionsBuilder()\n .include(\".*\" + JsonCodecBenchmarks.class.getSimpleName() + \".*\")\n .addProfiler(\"gc\")\n .build();\n\n new Runner(opt).run();\n }\n}\n" }, { "path": "benchmarks/src/test/java/zipkin2/codec/MoshiSpanDecoder.java", "content": "/*\n * Copyright The OpenZipkin Authors\n * SPDX-License-Identifier: Apache-2.0\n */\npackage zipkin2.codec;\n\nimport com.squareup.moshi.JsonAdapter;\nimport com.squareup.moshi.JsonReader;\nimport com.squareup.moshi.JsonWriter;\nimport com.squareup.moshi.Moshi;\nimport com.squareup.moshi.Types;\nimport java.io.IOException;\nimport java.nio.ByteBuffer;\nimport java.util.List;\nimport okio.Buffer;\nimport okio.BufferedSource;\nimport okio.Okio;\nimport okio.Timeout;\nimport zipkin2.Annotation;\nimport zipkin2.Endpoint;\nimport zipkin2.Span;\nimport zipkin2.internal.Nullable;\n\n/**\n * Read-only json adapters resurrected from before we switched to Java 6 as storage components can\n * be Java 7+\n */\npublic final class MoshiSpanDecoder {\n final JsonAdapter> listSpansAdapter;\n\n public static MoshiSpanDecoder create() {\n return new MoshiSpanDecoder();\n }\n\n MoshiSpanDecoder() {\n listSpansAdapter = new Moshi.Builder()\n .add(Span.class, SPAN_ADAPTER)\n .build().adapter(Types.newParameterizedType(List.class, Span.class));\n }\n\n public List decodeList(byte[] spans) {\n BufferedSource source = new Buffer().write(spans);\n try {\n return listSpansAdapter.fromJson(source);\n } catch (IOException e) {\n throw new AssertionError(e); // no I/O\n }\n }\n\n public List decodeList(ByteBuffer spans) {\n try {\n return listSpansAdapter.fromJson(JsonReader.of(Okio.buffer(new ByteBufferSource(spans))));\n } catch (IOException e) {\n throw new AssertionError(e); // no I/O\n }\n }\n\n static final class ByteBufferSource implements okio.Source {\n final ByteBuffer source;\n\n final Buffer.UnsafeCursor cursor = new Buffer.UnsafeCursor();\n\n ByteBufferSource(ByteBuffer source) {\n this.source = source;\n }\n\n @Override public long read(Buffer sink, long byteCount) {\n try (Buffer.UnsafeCursor ignored = sink.readAndWriteUnsafe(cursor)) {\n long oldSize = sink.size();\n int length = (int) Math.min(source.remaining(), Math.min(8192, byteCount));\n if (length == 0) return -1;\n cursor.expandBuffer(length);\n source.get(cursor.data, cursor.start, length);\n cursor.resizeBuffer(oldSize + length);\n return length;\n }\n }\n\n @Override public Timeout timeout() {\n return Timeout.NONE;\n }\n\n @Override public void close() {\n }\n }\n\n public static final JsonAdapter SPAN_ADAPTER =\n new JsonAdapter() {\n @Override\n public Span fromJson(JsonReader reader) throws IOException {\n Span.Builder result = Span.newBuilder();\n reader.beginObject();\n while (reader.hasNext()) {\n String nextName = reader.nextName();\n if (reader.peek() == JsonReader.Token.NULL) {\n reader.skipValue();\n continue;\n }\n switch (nextName) {\n case \"traceId\":\n result.traceId(reader.nextString());\n break;\n case \"parentId\":\n result.parentId(reader.nextString());\n break;\n case \"id\":\n result.id(reader.nextString());\n break;\n case \"kind\":\n result.kind(Span.Kind.valueOf(reader.nextString()));\n break;\n case \"name\":\n result.name(reader.nextString());\n break;\n case \"timestamp\":\n result.timestamp(reader.nextLong());\n break;\n case \"duration\":\n result.duration(reader.nextLong());\n break;\n case \"localEndpoint\":\n result.localEndpoint(ENDPOINT_ADAPTER.fromJson(reader));\n break;\n case \"remoteEndpoint\":\n result.remoteEndpoint(ENDPOINT_ADAPTER.fromJson(reader));\n break;\n case \"annotations\":\n reader.beginArray();\n while (reader.hasNext()) {\n Annotation a = ANNOTATION_ADAPTER.fromJson(reader);\n result.addAnnotation(a.timestamp(), a.value());\n }\n reader.endArray();\n break;\n case \"tags\":\n reader.beginObject();\n while (reader.hasNext()) {\n result.putTag(reader.nextName(), reader.nextString());\n }\n reader.endObject();\n break;\n case \"debug\":\n result.debug(reader.nextBoolean());\n break;\n case \"shared\":\n result.shared(reader.nextBoolean());\n break;\n default:\n reader.skipValue();\n }\n }\n reader.endObject();\n return result.build();\n }\n\n @Override\n public void toJson(JsonWriter writer, @Nullable Span value) {\n throw new UnsupportedOperationException();\n }\n };\n\n static final JsonAdapter ANNOTATION_ADAPTER =\n new JsonAdapter() {\n @Override\n public Annotation fromJson(JsonReader reader) throws IOException {\n reader.beginObject();\n Long timestamp = null;\n String value = null;\n while (reader.hasNext()) {\n switch (reader.nextName()) {\n case \"timestamp\":\n timestamp = reader.nextLong();\n break;\n case \"value\":\n value = reader.nextString();\n break;\n default:\n reader.skipValue();\n }\n }\n reader.endObject();\n if (timestamp == null || value == null) {\n throw new IllegalStateException(\"Incomplete annotation at \" + reader.getPath());\n }\n return Annotation.create(timestamp, value);\n }\n\n @Override\n public void toJson(JsonWriter writer, @Nullable Annotation value) {\n throw new UnsupportedOperationException();\n }\n };\n\n static final JsonAdapter ENDPOINT_ADAPTER =\n new JsonAdapter() {\n @Override\n public Endpoint fromJson(JsonReader reader) throws IOException {\n reader.beginObject();\n String serviceName = null, ipv4 = null, ipv6 = null;\n int port = 0;\n while (reader.hasNext()) {\n String nextName = reader.nextName();\n if (reader.peek() == JsonReader.Token.NULL) {\n reader.skipValue();\n continue;\n }\n switch (nextName) {\n case \"serviceName\":\n serviceName = reader.nextString();\n break;\n case \"ipv4\":\n ipv4 = reader.nextString();\n break;\n case \"ipv6\":\n ipv6 = reader.nextString();\n break;\n case \"port\":\n port = reader.nextInt();\n break;\n default:\n reader.skipValue();\n }\n }\n reader.endObject();\n if (serviceName == null && ipv4 == null && ipv6 == null && port == 0) return null;\n return Endpoint.newBuilder()\n .serviceName(serviceName)\n .ip(ipv4)\n .ip(ipv6)\n .port(port)\n .build();\n }\n\n @Override\n public void toJson(JsonWriter writer, @Nullable Endpoint value) {\n throw new UnsupportedOperationException();\n }\n }.nullSafe();\n}\n" }, { "path": "benchmarks/src/test/java/zipkin2/codec/MoshiSpanDecoderTest.java", "content": "/*\n * Copyright The OpenZipkin Authors\n * SPDX-License-Identifier: Apache-2.0\n */\npackage zipkin2.codec;\n\nimport io.netty.buffer.ByteBuf;\nimport io.netty.buffer.PooledByteBufAllocator;\nimport org.junit.jupiter.api.Test;\n\nimport static org.assertj.core.api.Assertions.assertThat;\nimport static zipkin2.TestObjects.TRACE;\n\npublic class MoshiSpanDecoderTest {\n byte[] encoded = SpanBytesEncoder.JSON_V2.encodeList(TRACE);\n\n @Test void decodeList_bytes() {\n assertThat(new MoshiSpanDecoder().decodeList(encoded))\n .isEqualTo(TRACE);\n }\n\n @Test void decodeList_byteBuffer() {\n ByteBuf encodedBuf = PooledByteBufAllocator.DEFAULT.buffer(encoded.length);\n encodedBuf.writeBytes(encoded);\n try {\n assertThat(new MoshiSpanDecoder().decodeList(encodedBuf.nioBuffer()))\n .isEqualTo(TRACE);\n } finally {\n encodedBuf.release();\n }\n }\n}\n" }, { "path": "benchmarks/src/test/java/zipkin2/codec/ProtoCodecBenchmarks.java", "content": "/*\n * Copyright The OpenZipkin Authors\n * SPDX-License-Identifier: Apache-2.0\n */\npackage zipkin2.codec;\n\nimport io.netty.buffer.ByteBuf;\nimport io.netty.buffer.PooledByteBufAllocator;\nimport java.util.Collections;\nimport java.util.List;\nimport java.util.concurrent.TimeUnit;\nimport org.openjdk.jmh.annotations.Benchmark;\nimport org.openjdk.jmh.annotations.BenchmarkMode;\nimport org.openjdk.jmh.annotations.Fork;\nimport org.openjdk.jmh.annotations.Measurement;\nimport org.openjdk.jmh.annotations.Mode;\nimport org.openjdk.jmh.annotations.OutputTimeUnit;\nimport org.openjdk.jmh.annotations.Scope;\nimport org.openjdk.jmh.annotations.Setup;\nimport org.openjdk.jmh.annotations.State;\nimport org.openjdk.jmh.annotations.TearDown;\nimport org.openjdk.jmh.annotations.Threads;\nimport org.openjdk.jmh.annotations.Warmup;\nimport org.openjdk.jmh.runner.Runner;\nimport org.openjdk.jmh.runner.options.Options;\nimport org.openjdk.jmh.runner.options.OptionsBuilder;\nimport zipkin2.Span;\n\nimport static java.nio.charset.StandardCharsets.UTF_8;\nimport static zipkin2.storage.cassandra.internal.Resources.resourceToString;\n\n@Measurement(iterations = 5, time = 1)\n@Warmup(iterations = 10, time = 1)\n@Fork(3)\n@BenchmarkMode(Mode.SampleTime)\n@OutputTimeUnit(TimeUnit.MICROSECONDS)\n@State(Scope.Thread)\n@Threads(1)\npublic class ProtoCodecBenchmarks {\n\n static final byte[] clientSpanJsonV2 = resourceToString(\"/zipkin2-client.json\").getBytes(UTF_8);\n static final Span clientSpan = SpanBytesDecoder.JSON_V2.decodeOne(clientSpanJsonV2);\n\n // Assume a message is 1000 spans (which is a high number for as this is per-node-second)\n static final List spans = Collections.nCopies(1000, clientSpan);\n static final byte[] encodedBytes = SpanBytesEncoder.PROTO3.encodeList(spans);\n\n private ByteBuf encodedBuf;\n\n @Setup\n public void setup() {\n encodedBuf = PooledByteBufAllocator.DEFAULT.buffer(encodedBytes.length);\n encodedBuf.writeBytes(encodedBytes);\n }\n\n @TearDown\n public void tearDown() {\n encodedBuf.release();\n }\n\n @Benchmark\n public List bytes_zipkinDecoder() {\n return SpanBytesDecoder.PROTO3.decodeList(encodedBytes);\n }\n\n @Benchmark\n public List bytes_protobufDecoder() {\n return ProtobufSpanDecoder.decodeList(encodedBytes);\n }\n\n @Benchmark\n public List bytes_wireDecoder() {\n return WireSpanDecoder.decodeList(encodedBytes);\n }\n\n @Benchmark\n public List bytebuffer_zipkinDecoder() {\n return SpanBytesDecoder.PROTO3.decodeList(encodedBuf.nioBuffer());\n }\n\n @Benchmark\n public List bytebuffer_protobufDecoder() {\n return ProtobufSpanDecoder.decodeList(encodedBuf.nioBuffer());\n }\n\n @Benchmark\n public List bytebuffer_wireDecoder() {\n return WireSpanDecoder.decodeList(encodedBuf.nioBuffer());\n }\n\n // Convenience main entry-point\n public static void main(String[] args) throws Exception {\n Options opt = new OptionsBuilder()\n .include(\".*\" + ProtoCodecBenchmarks.class.getSimpleName())\n .addProfiler(\"gc\")\n .build();\n\n new Runner(opt).run();\n }\n}\n" }, { "path": "benchmarks/src/test/java/zipkin2/codec/ProtobufSpanDecoder.java", "content": "/*\n * Copyright The OpenZipkin Authors\n * SPDX-License-Identifier: Apache-2.0\n */\npackage zipkin2.codec;\n\nimport com.google.protobuf.CodedInputStream;\nimport com.google.protobuf.WireFormat;\nimport java.io.IOException;\nimport java.nio.ByteBuffer;\nimport java.util.ArrayList;\nimport java.util.List;\nimport java.util.logging.Logger;\nimport zipkin2.Endpoint;\nimport zipkin2.Span;\nimport zipkin2.internal.RecyclableBuffers;\n\npublic class ProtobufSpanDecoder {\n static final Logger LOG = Logger.getLogger(ProtobufSpanDecoder.class.getName());\n static final boolean DEBUG = false;\n\n // map in proto is a special field with key, value\n static final int MAP_KEY_KEY = (1 << 3) | WireFormat.WIRETYPE_LENGTH_DELIMITED;\n static final int MAP_VALUE_KEY = (2 << 3) | WireFormat.WIRETYPE_LENGTH_DELIMITED;\n\n static boolean decodeTag(CodedInputStream input, Span.Builder span) throws IOException {\n // now, we are in the tag fields\n String key = null, value = \"\"; // empty tags allowed\n\n boolean done = false;\n while (!done) {\n int tag = input.readTag();\n switch (tag) {\n case 0:\n done = true;\n break;\n case MAP_KEY_KEY: {\n key = input.readStringRequireUtf8();\n break;\n }\n case MAP_VALUE_KEY: {\n value = input.readStringRequireUtf8();\n break;\n }\n default: {\n logAndSkip(input, tag);\n break;\n }\n }\n }\n\n if (key == null) return false;\n span.putTag(key, value);\n return true;\n }\n\n static boolean decodeAnnotation(CodedInputStream input, Span.Builder span) throws IOException {\n long timestamp = 0L;\n String value = null;\n\n boolean done = false;\n while (!done) {\n int tag = input.readTag();\n switch (tag) {\n case 0:\n done = true;\n break;\n case 9: {\n timestamp = input.readFixed64();\n break;\n }\n case 18: {\n value = input.readStringRequireUtf8();\n break;\n }\n default: {\n logAndSkip(input, tag);\n break;\n }\n }\n }\n\n if (timestamp == 0L || value == null) return false;\n span.addAnnotation(timestamp, value);\n return true;\n }\n\n private static Endpoint decodeEndpoint(CodedInputStream input) throws IOException {\n Endpoint.Builder endpoint = Endpoint.newBuilder();\n\n boolean done = false;\n while (!done) {\n int tag = input.readTag();\n switch (tag) {\n case 0:\n done = true;\n break;\n case 10: {\n endpoint.serviceName(input.readStringRequireUtf8());\n break;\n }\n case 18:\n case 26: {\n endpoint.parseIp(input.readByteArray());\n break;\n }\n case 32: {\n endpoint.port(input.readInt32());\n break;\n }\n default: {\n logAndSkip(input, tag);\n break;\n }\n }\n }\n return endpoint.build();\n }\n\n public static Span decodeOne(CodedInputStream input) throws IOException {\n Span.Builder span = Span.newBuilder();\n\n boolean done = false;\n while (!done) {\n int tag = input.readTag();\n switch (tag) {\n case 0:\n done = true;\n break;\n case 10: {\n span.traceId(readHexString(input));\n break;\n }\n case 18: {\n span.parentId(readHexString(input));\n break;\n }\n case 26: {\n span.id(readHexString(input));\n break;\n }\n case 32: {\n int kind = input.readEnum();\n if (kind == 0) break;\n if (kind > Span.Kind.values().length) break;\n span.kind(Span.Kind.values()[kind - 1]);\n break;\n }\n case 42: {\n span.name(input.readStringRequireUtf8());\n break;\n }\n case 49: {\n span.timestamp(input.readFixed64());\n break;\n }\n case 56: {\n span.duration(input.readUInt64());\n break;\n }\n case 66: {\n int length = input.readRawVarint32();\n int oldLimit = input.pushLimit(length);\n\n span.localEndpoint(decodeEndpoint(input));\n\n input.checkLastTagWas(0);\n input.popLimit(oldLimit);\n break;\n }\n case 74: {\n int length = input.readRawVarint32();\n int oldLimit = input.pushLimit(length);\n\n span.remoteEndpoint(decodeEndpoint(input));\n\n input.checkLastTagWas(0);\n input.popLimit(oldLimit);\n break;\n }\n case 82: {\n int length = input.readRawVarint32();\n int oldLimit = input.pushLimit(length);\n\n decodeAnnotation(input, span);\n\n input.checkLastTagWas(0);\n input.popLimit(oldLimit);\n break;\n }\n case 90: {\n int length = input.readRawVarint32();\n int oldLimit = input.pushLimit(length);\n\n decodeTag(input, span);\n\n input.checkLastTagWas(0);\n input.popLimit(oldLimit);\n break;\n }\n case 96: {\n span.debug(input.readBool());\n break;\n }\n case 104: {\n span.shared(input.readBool());\n break;\n }\n default: {\n logAndSkip(input, tag);\n break;\n }\n }\n }\n\n return span.build();\n }\n\n public static List decodeList(byte[] spans) {\n return decodeList(CodedInputStream.newInstance(spans));\n }\n\n public static List decodeList(ByteBuffer spans) {\n return decodeList(CodedInputStream.newInstance(spans));\n }\n\n public static List decodeList(CodedInputStream input) {\n ArrayList spans = new ArrayList<>();\n\n try {\n boolean done = false;\n while (!done) {\n int tag = input.readTag();\n switch (tag) {\n case 0:\n done = true;\n break;\n case 10:\n int length = input.readRawVarint32();\n int oldLimit = input.pushLimit(length);\n spans.add(decodeOne(input));\n input.checkLastTagWas(0);\n input.popLimit(oldLimit);\n break;\n default: {\n logAndSkip(input, tag);\n break;\n }\n }\n }\n } catch (IOException e) {\n throw new RuntimeException(e);\n }\n\n return spans;\n }\n\n static final char[] HEX_DIGITS =\n {'0', '1', '2', '3', '4', '5', '6', '7', '8', '9', 'a', 'b', 'c', 'd', 'e', 'f'};\n\n private static String readHexString(CodedInputStream input) throws IOException {\n int size = input.readRawVarint32();\n int length = size * 2;\n\n // All our hex fields are at most 32 characters.\n if (length > 32) {\n throw new AssertionError(\"hex field greater than 32 chars long: \" + length);\n }\n\n char[] result = RecyclableBuffers.shortStringBuffer();\n\n for (int i = 0; i < length; i += 2) {\n byte b = input.readRawByte();\n result[i] = HEX_DIGITS[(b >> 4) & 0xf];\n result[i + 1] = HEX_DIGITS[b & 0xf];\n }\n\n return new String(result, 0, length);\n }\n\n static void logAndSkip(CodedInputStream input, int tag) throws IOException {\n if (DEBUG) { // avoiding volatile reads as we don't log on skip in our normal codec\n int nextWireType = WireFormat.getTagWireType(tag);\n int nextFieldNumber = WireFormat.getTagFieldNumber(tag);\n LOG.fine(\"Skipping field: byte=%s, fieldNumber=%s, wireType=%s\".formatted(\n input.getTotalBytesRead(), nextFieldNumber, nextWireType));\n }\n input.skipField(tag);\n }\n}\n" }, { "path": "benchmarks/src/test/java/zipkin2/codec/WireSpanDecoder.java", "content": "/*\n * Copyright The OpenZipkin Authors\n * SPDX-License-Identifier: Apache-2.0\n */\npackage zipkin2.codec;\n\nimport com.google.protobuf.WireFormat;\nimport com.squareup.wire.ProtoAdapter;\nimport com.squareup.wire.ProtoReader;\nimport java.io.IOException;\nimport java.io.UncheckedIOException;\nimport java.nio.ByteBuffer;\nimport java.util.ArrayList;\nimport java.util.List;\nimport java.util.logging.Logger;\nimport okio.Buffer;\nimport okio.ByteString;\nimport zipkin2.Endpoint;\nimport zipkin2.Span;\nimport zipkin2.internal.RecyclableBuffers;\n\npublic class WireSpanDecoder {\n static final Logger LOG = Logger.getLogger(WireSpanDecoder.class.getName());\n static final boolean DEBUG = false;\n\n static boolean decodeTag(ProtoReader input, Span.Builder span) throws IOException {\n // now, we are in the tag fields\n String key = null, value = \"\"; // empty tags allowed\n\n boolean done = false;\n while (!done) {\n int tag = input.nextTag();\n switch (tag) {\n case -1:\n done = true;\n break;\n case 1: {\n key = input.readString();\n break;\n }\n case 2: {\n value = input.readString();\n break;\n }\n default: {\n logAndSkip(input, tag);\n break;\n }\n }\n }\n\n if (key == null) return false;\n span.putTag(key, value);\n return true;\n }\n\n static boolean decodeAnnotation(ProtoReader input, Span.Builder span) throws IOException {\n long timestamp = 0L;\n String value = null;\n\n boolean done = false;\n while (!done) {\n int tag = input.nextTag();\n switch (tag) {\n case -1:\n done = true;\n break;\n case 1: {\n timestamp = input.readFixed64();\n break;\n }\n case 2: {\n value = input.readString();\n break;\n }\n default: {\n logAndSkip(input, tag);\n break;\n }\n }\n }\n\n if (timestamp == 0L || value == null) return false;\n span.addAnnotation(timestamp, value);\n return true;\n }\n\n private static Endpoint decodeEndpoint(ProtoReader input) throws IOException {\n Endpoint.Builder endpoint = Endpoint.newBuilder();\n\n boolean done = false;\n while (!done) {\n int tag = input.nextTag();\n switch (tag) {\n case -1:\n done = true;\n break;\n case 1: {\n String s = input.readString();\n endpoint.serviceName(s);\n break;\n }\n case 2:\n case 3: {\n endpoint.parseIp(input.readBytes().toByteArray());\n break;\n }\n case 4: {\n endpoint.port(input.readVarint32());\n break;\n }\n default: {\n logAndSkip(input, tag);\n break;\n }\n }\n }\n return endpoint.build();\n }\n\n public static Span decodeOne(ProtoReader input) throws IOException {\n Span.Builder span = Span.newBuilder();\n\n boolean done = false;\n while (!done) {\n int tag = input.nextTag();\n switch (tag) {\n case -1:\n done = true;\n break;\n case 1: {\n span.traceId(readHexString(input));\n break;\n }\n case 2: {\n span.parentId(readHexString(input));\n break;\n }\n case 3: {\n span.id(readHexString(input));\n break;\n }\n case 4: {\n int kind = input.readVarint32();\n if (kind == 0) break;\n if (kind > Span.Kind.values().length) break;\n span.kind(Span.Kind.values()[kind - 1]);\n break;\n }\n case 5: {\n String name = input.readString();\n span.name(name);\n break;\n }\n case 6: {\n span.timestamp(input.readFixed64());\n break;\n }\n case 7: {\n span.duration(input.readVarint64());\n break;\n }\n case 8: {\n long token = input.beginMessage();\n\n span.localEndpoint(decodeEndpoint(input));\n\n input.endMessageAndGetUnknownFields(token);\n break;\n }\n case 9: {\n long token = input.beginMessage();\n\n span.remoteEndpoint(decodeEndpoint(input));\n\n input.endMessageAndGetUnknownFields(token);\n break;\n }\n case 10: {\n long token = input.beginMessage();\n\n decodeAnnotation(input, span);\n\n input.endMessageAndGetUnknownFields(token);\n break;\n }\n case 11: {\n long token = input.beginMessage();\n\n decodeTag(input, span);\n\n input.endMessageAndGetUnknownFields(token);\n break;\n }\n case 12: {\n span.debug(ProtoAdapter.BOOL.decode(input));\n break;\n }\n case 13: {\n span.shared(ProtoAdapter.BOOL.decode(input));\n break;\n }\n default: {\n logAndSkip(input, tag);\n break;\n }\n }\n }\n\n return span.build();\n }\n\n public static List decodeList(byte[] spans) {\n return decodeList(new ProtoReader(new Buffer().write(spans)));\n }\n\n public static List decodeList(ByteBuffer spans) {\n Buffer buffer = new Buffer();\n try {\n buffer.write(spans);\n } catch (IOException e) {\n throw new AssertionError(e); // no I/O\n }\n return decodeList(new ProtoReader(buffer));\n }\n\n public static List decodeList(ProtoReader input) {\n ArrayList spans = new ArrayList<>();\n\n final long token;\n try {\n token = input.beginMessage();\n } catch (IOException e) {\n throw new UncheckedIOException(e);\n }\n\n try {\n boolean done = false;\n while (!done) {\n int tag = input.nextTag();\n switch (tag) {\n case -1:\n done = true;\n break;\n case 1: {\n long subToken = input.beginMessage();\n\n spans.add(decodeOne(input));\n\n input.endMessageAndGetUnknownFields(subToken);\n break;\n }\n default: {\n logAndSkip(input, tag);\n break;\n }\n }\n }\n } catch (IOException e) {\n throw new RuntimeException(e);\n }\n\n try {\n input.endMessageAndGetUnknownFields(token);\n } catch (IOException e) {\n throw new UncheckedIOException(e);\n }\n\n return spans;\n }\n\n static final char[] HEX_DIGITS =\n {'0', '1', '2', '3', '4', '5', '6', '7', '8', '9', 'a', 'b', 'c', 'd', 'e', 'f'};\n\n // https://github.com/square/wire/issues/958\n private static String readHexString(ProtoReader input) throws IOException {\n ByteString bytes = input.readBytes();\n int length = bytes.size() * 2;\n\n // All our hex fields are at most 32 characters.\n if (length > 32) {\n throw new AssertionError(\"hex field greater than 32 chars long: \" + length);\n }\n\n char[] result = RecyclableBuffers.shortStringBuffer();\n\n for (int i = 0; i < bytes.size(); i++) {\n byte b = bytes.getByte(i);\n result[2 * i] = HEX_DIGITS[(b >> 4) & 0xf];\n result[2 * i + 1] = HEX_DIGITS[b & 0xf];\n }\n\n return new String(result, 0, length);\n }\n\n static void logAndSkip(ProtoReader input, int tag) throws IOException {\n if (DEBUG) { // avoiding volatile reads as we don't log on skip in our normal codec\n int nextWireType = WireFormat.getTagWireType(tag);\n int nextFieldNumber = WireFormat.getTagFieldNumber(tag);\n LOG.fine(\"Skipping field: byte=%s, fieldNumber=%s, wireType=%s\".formatted(\n 0, nextFieldNumber, nextWireType));\n }\n input.skip();\n }\n}\n" }, { "path": "benchmarks/src/test/java/zipkin2/collector/MetricsBenchmarks.java", "content": "/*\n * Copyright The OpenZipkin Authors\n * SPDX-License-Identifier: Apache-2.0\n */\npackage zipkin2.collector;\n\nimport io.micrometer.core.instrument.MeterRegistry;\nimport io.micrometer.prometheus.PrometheusConfig;\nimport io.micrometer.prometheus.PrometheusMeterRegistry;\nimport java.util.concurrent.TimeUnit;\nimport org.openjdk.jmh.annotations.Benchmark;\nimport org.openjdk.jmh.annotations.BenchmarkMode;\nimport org.openjdk.jmh.annotations.Fork;\nimport org.openjdk.jmh.annotations.Measurement;\nimport org.openjdk.jmh.annotations.Mode;\nimport org.openjdk.jmh.annotations.OutputTimeUnit;\nimport org.openjdk.jmh.annotations.Scope;\nimport org.openjdk.jmh.annotations.State;\nimport org.openjdk.jmh.annotations.Threads;\nimport org.openjdk.jmh.annotations.Warmup;\nimport org.openjdk.jmh.runner.Runner;\nimport org.openjdk.jmh.runner.RunnerException;\nimport org.openjdk.jmh.runner.options.Options;\nimport org.openjdk.jmh.runner.options.OptionsBuilder;\nimport zipkin2.server.internal.MicrometerCollectorMetrics;\n\n@Measurement(iterations = 80, time = 1)\n@Warmup(iterations = 20, time = 1)\n@Fork(3)\n@BenchmarkMode(Mode.AverageTime)\n@OutputTimeUnit(TimeUnit.MICROSECONDS)\n@State(Scope.Thread)\n@Threads(1)\npublic class MetricsBenchmarks {\n static final int LONG_SPAN = 5000;\n static final int MEDIUM_SPAN = 1000;\n static final int SHORT_SPAN = 500;\n private MeterRegistry registry = new PrometheusMeterRegistry(PrometheusConfig.DEFAULT);\n private InMemoryCollectorMetrics inMemoryCollectorMetrics = new InMemoryCollectorMetrics()\n .forTransport(\"jmh\");\n private MicrometerCollectorMetrics micrometerCollectorMetrics =\n new MicrometerCollectorMetrics(registry)\n .forTransport(\"jmh\");\n\n @Benchmark\n public int incrementBytes_longSpans_inMemory() {\n return incrementBytes(inMemoryCollectorMetrics, LONG_SPAN);\n }\n\n @Benchmark\n public int incrementBytes_longSpans_Actuate() {\n return incrementBytes(micrometerCollectorMetrics, LONG_SPAN);\n }\n\n @Benchmark\n public int incrementBytes_mediumSpans_inMemory() {\n return incrementBytes(inMemoryCollectorMetrics, MEDIUM_SPAN);\n }\n\n @Benchmark\n public int incrementBytes_mediumSpans_Actuate() {\n return incrementBytes(micrometerCollectorMetrics, MEDIUM_SPAN);\n }\n\n @Benchmark\n public int incrementBytes_shortSpans_inMemory() {\n return incrementBytes(inMemoryCollectorMetrics, SHORT_SPAN);\n }\n\n @Benchmark\n public int incrementBytes_shortSpans_Actuate() {\n return incrementBytes(micrometerCollectorMetrics, SHORT_SPAN);\n }\n\n private int incrementBytes(CollectorMetrics collectorMetrics, int bytes) {\n collectorMetrics.incrementBytes(bytes);\n return bytes;\n }\n\n // Convenience main entry-point\n public static void main(String[] args) throws RunnerException {\n Options opt = new OptionsBuilder()\n .include(\".*\" + MetricsBenchmarks.class.getSimpleName() + \".*\")\n .threads(40)\n .build();\n\n new Runner(opt).run();\n }\n}\n" }, { "path": "benchmarks/src/test/java/zipkin2/elasticsearch/internal/BulkRequestBenchmarks.java", "content": "/*\n * Copyright The OpenZipkin Authors\n * SPDX-License-Identifier: Apache-2.0\n */\npackage zipkin2.elasticsearch.internal;\n\nimport com.linecorp.armeria.common.HttpRequest;\nimport io.netty.buffer.ByteBuf;\nimport io.netty.buffer.PooledByteBufAllocator;\nimport java.util.concurrent.TimeUnit;\nimport org.openjdk.jmh.annotations.Benchmark;\nimport org.openjdk.jmh.annotations.BenchmarkMode;\nimport org.openjdk.jmh.annotations.Fork;\nimport org.openjdk.jmh.annotations.Measurement;\nimport org.openjdk.jmh.annotations.Mode;\nimport org.openjdk.jmh.annotations.OutputTimeUnit;\nimport org.openjdk.jmh.annotations.Scope;\nimport org.openjdk.jmh.annotations.State;\nimport org.openjdk.jmh.annotations.Threads;\nimport org.openjdk.jmh.annotations.Warmup;\nimport org.openjdk.jmh.runner.Runner;\nimport org.openjdk.jmh.runner.RunnerException;\nimport org.openjdk.jmh.runner.options.Options;\nimport org.openjdk.jmh.runner.options.OptionsBuilder;\nimport zipkin2.Span;\nimport zipkin2.codec.SpanBytesDecoder;\nimport zipkin2.elasticsearch.ElasticsearchStorage;\nimport zipkin2.elasticsearch.internal.BulkCallBuilder.IndexEntry;\n\nimport static java.nio.charset.StandardCharsets.UTF_8;\nimport static zipkin2.elasticsearch.ElasticsearchVersion.V6_0;\nimport static zipkin2.storage.cassandra.internal.Resources.resourceToString;\n\n@Measurement(iterations = 5, time = 1)\n@Warmup(iterations = 10, time = 1)\n@Fork(3)\n@BenchmarkMode(Mode.SampleTime)\n@OutputTimeUnit(TimeUnit.MICROSECONDS)\n@State(Scope.Thread)\n@Threads(2)\npublic class BulkRequestBenchmarks {\n static final Span CLIENT_SPAN =\n SpanBytesDecoder.JSON_V2.decodeOne(resourceToString(\"/zipkin2-client.json\").getBytes(UTF_8));\n\n final ElasticsearchStorage es = ElasticsearchStorage.newBuilder(() -> null).build();\n final long indexTimestamp = CLIENT_SPAN.timestampAsLong() / 1000L;\n final String spanIndex =\n es.indexNameFormatter().formatTypeAndTimestampForInsert(\"span\", '-', indexTimestamp);\n final IndexEntry entry =\n BulkCallBuilder.newIndexEntry(spanIndex, \"span\", CLIENT_SPAN, BulkIndexWriter.SPAN);\n\n @Benchmark public ByteBuf writeRequest_singleSpan() {\n return BulkCallBuilder.serialize(PooledByteBufAllocator.DEFAULT, entry, true);\n }\n\n @Benchmark public HttpRequest buildAndWriteRequest_singleSpan() {\n BulkCallBuilder builder = new BulkCallBuilder(es, V6_0, \"index-span\");\n builder.index(spanIndex, \"span\", CLIENT_SPAN, BulkIndexWriter.SPAN);\n return builder.build().request.get();\n }\n\n @Benchmark public HttpRequest buildAndWriteRequest_tenSpans() {\n BulkCallBuilder builder = new BulkCallBuilder(es, V6_0, \"index-span\");\n for (int i = 0; i < 10; i++) {\n builder.index(spanIndex, \"span\", CLIENT_SPAN, BulkIndexWriter.SPAN);\n }\n return builder.build().request.get();\n }\n\n // Convenience main entry-point\n public static void main(String[] args) throws RunnerException {\n Options opt = new OptionsBuilder()\n .addProfiler(\"gc\")\n .include(\".*\" + BulkRequestBenchmarks.class.getSimpleName() + \".*\")\n .build();\n\n new Runner(opt).run();\n }\n}\n" }, { "path": "benchmarks/src/test/java/zipkin2/internal/DelayLimiterBenchmarks.java", "content": "/*\n * Copyright The OpenZipkin Authors\n * SPDX-License-Identifier: Apache-2.0\n */\npackage zipkin2.internal;\n\nimport java.util.Random;\nimport java.util.concurrent.TimeUnit;\nimport org.openjdk.jmh.annotations.Benchmark;\nimport org.openjdk.jmh.annotations.BenchmarkMode;\nimport org.openjdk.jmh.annotations.Fork;\nimport org.openjdk.jmh.annotations.Measurement;\nimport org.openjdk.jmh.annotations.Mode;\nimport org.openjdk.jmh.annotations.OutputTimeUnit;\nimport org.openjdk.jmh.annotations.Scope;\nimport org.openjdk.jmh.annotations.State;\nimport org.openjdk.jmh.annotations.Threads;\nimport org.openjdk.jmh.annotations.Warmup;\nimport org.openjdk.jmh.runner.Runner;\nimport org.openjdk.jmh.runner.RunnerException;\nimport org.openjdk.jmh.runner.options.Options;\nimport org.openjdk.jmh.runner.options.OptionsBuilder;\n\n@Measurement(iterations = 5, time = 1)\n@Warmup(iterations = 10, time = 1)\n@Fork(3)\n@BenchmarkMode(Mode.SampleTime)\n@OutputTimeUnit(TimeUnit.MICROSECONDS)\n@State(Scope.Thread)\n@Threads(2)\npublic class DelayLimiterBenchmarks {\n\n final Random rng = new Random();\n final DelayLimiter limiter = DelayLimiter.newBuilder()\n .ttl(1L, TimeUnit.HOURS) // legacy default from Cassandra\n .cardinality(5 * 4000) // Ex. 5 site tags with cardinality 4000 each\n .build();\n\n @Benchmark public boolean shouldInvoke_randomData() {\n return limiter.shouldInvoke(rng.nextLong());\n }\n\n @Benchmark public boolean shouldInvoke_sameData() {\n return limiter.shouldInvoke(1L);\n }\n\n // Convenience main entry-point\n public static void main(String[] args) throws RunnerException {\n Options opt = new OptionsBuilder()\n .addProfiler(\"gc\")\n .include(\".*\" + DelayLimiterBenchmarks.class.getSimpleName() + \".*\")\n .build();\n\n new Runner(opt).run();\n }\n}\n" }, { "path": "benchmarks/src/test/java/zipkin2/internal/Proto3CodecInteropTest.java", "content": "/*\n * Copyright The OpenZipkin Authors\n * SPDX-License-Identifier: Apache-2.0\n */\npackage zipkin2.internal;\n\nimport com.squareup.wire.ProtoWriter;\nimport java.io.IOException;\nimport java.util.List;\nimport java.util.Map;\nimport okio.ByteString;\nimport org.assertj.core.data.MapEntry;\nimport org.junit.jupiter.api.Test;\nimport zipkin2.codec.SpanBytesDecoder;\nimport zipkin2.codec.SpanBytesEncoder;\nimport zipkin2.internal.Proto3ZipkinFields.TagField;\nimport zipkin2.proto3.Annotation;\nimport zipkin2.proto3.Endpoint;\nimport zipkin2.proto3.ListOfSpans;\nimport zipkin2.proto3.Span;\n\nimport static okio.ByteString.decodeHex;\nimport static org.assertj.core.api.Assertions.assertThat;\nimport static org.assertj.core.data.MapEntry.entry;\nimport static zipkin2.internal.Proto3ZipkinFields.SPAN;\nimport static zipkin2.internal.Proto3ZipkinFields.SpanField.ANNOTATION;\nimport static zipkin2.internal.Proto3ZipkinFields.SpanField.LOCAL_ENDPOINT;\nimport static zipkin2.internal.Proto3ZipkinFields.SpanField.REMOTE_ENDPOINT;\nimport static zipkin2.internal.Proto3ZipkinFields.SpanField.TAG_KEY;\n\n// Compares against Square Wire as it is easier than Google's protobuf tooling\npublic class Proto3CodecInteropTest {\n static final zipkin2.Endpoint ORDER = zipkin2.Endpoint.newBuilder()\n .serviceName(\"订单维护服务\")\n .ip(\"2001:db8::c001\")\n .build();\n\n static final zipkin2.Endpoint PROFILE = zipkin2.Endpoint.newBuilder()\n .serviceName(\"个人信息服务\")\n .ip(\"192.168.99.101\")\n .port(9000)\n .build();\n\n static final zipkin2.Span ZIPKIN_SPAN = zipkin2.Span.newBuilder()\n .traceId(\"4d1e00c0db9010db86154a4ba6e91385\")\n .parentId(\"86154a4ba6e91385\")\n .id(\"4d1e00c0db9010db\")\n .kind(zipkin2.Span.Kind.SERVER)\n .name(\"个人信息查询\")\n .timestamp(1472470996199000L)\n .duration(207000L)\n .localEndpoint(ORDER)\n .remoteEndpoint(PROFILE)\n .addAnnotation(1472470996199000L, \"foo happened\")\n .putTag(\"http.path\", \"/person/profile/query\")\n .putTag(\"http.status_code\", \"403\")\n .putTag(\"clnt/finagle.version\", \"6.45.0\")\n .putTag(\"error\", \"此用户没有操作权限\")\n .shared(true)\n .build();\n static final List ZIPKIN_SPANS = List.of(ZIPKIN_SPAN, ZIPKIN_SPAN);\n\n static final Span PROTO_SPAN = new Span.Builder()\n .trace_id(decodeHex(ZIPKIN_SPAN.traceId()))\n .parent_id(decodeHex(ZIPKIN_SPAN.parentId()))\n .id(decodeHex(ZIPKIN_SPAN.id()))\n .kind(Span.Kind.valueOf(ZIPKIN_SPAN.kind().name()))\n .name(ZIPKIN_SPAN.name())\n .timestamp(ZIPKIN_SPAN.timestampAsLong())\n .duration(ZIPKIN_SPAN.durationAsLong())\n .local_endpoint(new Endpoint.Builder()\n .service_name(ORDER.serviceName())\n .ipv6(ByteString.of(ORDER.ipv6Bytes())).build()\n )\n .remote_endpoint(new Endpoint.Builder()\n .service_name(PROFILE.serviceName())\n .ipv4(ByteString.of(PROFILE.ipv4Bytes()))\n .port(PROFILE.portAsInt()).build()\n )\n .annotations(List.of(new Annotation.Builder()\n .timestamp(ZIPKIN_SPAN.annotations().get(0).timestamp())\n .value(ZIPKIN_SPAN.annotations().get(0).value())\n .build()))\n .tags(ZIPKIN_SPAN.tags())\n .shared(true)\n .build();\n ListOfSpans PROTO_SPANS = new ListOfSpans.Builder()\n .spans(List.of(PROTO_SPAN, PROTO_SPAN)).build();\n\n @Test void encodeIsCompatible() throws IOException {\n okio.Buffer buffer = new okio.Buffer();\n\n Span.ADAPTER.encodeWithTag(new ProtoWriter(buffer), 1, PROTO_SPAN);\n\n assertThat(SpanBytesEncoder.PROTO3.encode(ZIPKIN_SPAN))\n .containsExactly(buffer.readByteArray());\n }\n\n @Test void decodeOneIsCompatible() {\n assertThat(SpanBytesDecoder.PROTO3.decodeOne(PROTO_SPANS.encode()))\n .isEqualTo(ZIPKIN_SPAN);\n }\n\n @Test void decodeListIsCompatible() {\n assertThat(SpanBytesDecoder.PROTO3.decodeList(PROTO_SPANS.encode()))\n .containsExactly(ZIPKIN_SPAN, ZIPKIN_SPAN);\n }\n\n @Test void encodeListIsCompatible_buff() {\n byte[] wireBytes = PROTO_SPANS.encode();\n byte[] zipkin_buff = new byte[10 + wireBytes.length];\n\n assertThat(SpanBytesEncoder.PROTO3.encodeList(ZIPKIN_SPANS, zipkin_buff, 5))\n .isEqualTo(wireBytes.length);\n\n assertThat(zipkin_buff)\n .startsWith(0, 0, 0, 0, 0)\n .containsSequence(wireBytes)\n .endsWith(0, 0, 0, 0, 0);\n }\n\n @Test void encodeListIsCompatible() {\n byte[] wireBytes = PROTO_SPANS.encode();\n\n assertThat(SpanBytesEncoder.PROTO3.encodeList(ZIPKIN_SPANS))\n .containsExactly(wireBytes);\n }\n\n @Test void span_sizeInBytes_matchesWire() {\n assertThat(SPAN.sizeInBytes(ZIPKIN_SPAN))\n .isEqualTo(Span.ADAPTER.encodedSizeWithTag(SPAN.fieldNumber, PROTO_SPAN));\n }\n\n @Test void annotation_sizeInBytes_matchesWire() {\n zipkin2.Annotation zipkinAnnotation = ZIPKIN_SPAN.annotations().get(0);\n\n assertThat(ANNOTATION.sizeInBytes(zipkinAnnotation)).isEqualTo(\n Annotation.ADAPTER.encodedSizeWithTag(ANNOTATION.fieldNumber, PROTO_SPAN.annotations.get(0))\n );\n }\n\n @Test void annotation_write_matchesWire() {\n zipkin2.Annotation zipkinAnnotation = ZIPKIN_SPAN.annotations().get(0);\n Span wireSpan = new Span.Builder().annotations(PROTO_SPAN.annotations).build();\n\n byte[] zipkinBytes = new byte[ANNOTATION.sizeInBytes(zipkinAnnotation)];\n ANNOTATION.write(WriteBuffer.wrap(zipkinBytes, 0), zipkinAnnotation);\n\n assertThat(zipkinBytes)\n .containsExactly(wireSpan.encode());\n }\n\n @Test void annotation_read_matchesWireEncodingWithTag() {\n zipkin2.Annotation zipkinAnnotation = ZIPKIN_SPAN.annotations().get(0);\n Span wireSpan = new Span.Builder().annotations(PROTO_SPAN.annotations).build();\n\n ReadBuffer wireBytes = ReadBuffer.wrap(wireSpan.encode());\n assertThat(wireBytes.readVarint32())\n .isEqualTo(ANNOTATION.key);\n\n zipkin2.Span.Builder builder = zipkinSpanBuilder();\n ANNOTATION.readLengthPrefixAndValue(wireBytes, builder);\n assertThat(builder.build().annotations())\n .containsExactly(zipkinAnnotation);\n }\n\n @Test void endpoint_sizeInBytes_matchesWireEncodingWithTag() {\n assertThat(LOCAL_ENDPOINT.sizeInBytes(ZIPKIN_SPAN.localEndpoint())).isEqualTo(\n Endpoint.ADAPTER.encodedSizeWithTag(LOCAL_ENDPOINT.fieldNumber, PROTO_SPAN.local_endpoint)\n );\n\n assertThat(REMOTE_ENDPOINT.sizeInBytes(ZIPKIN_SPAN.remoteEndpoint())).isEqualTo(\n Endpoint.ADAPTER.encodedSizeWithTag(REMOTE_ENDPOINT.fieldNumber, PROTO_SPAN.remote_endpoint)\n );\n }\n\n @Test void localEndpoint_write_matchesWire() {\n byte[] zipkinBytes = new byte[LOCAL_ENDPOINT.sizeInBytes(ZIPKIN_SPAN.localEndpoint())];\n LOCAL_ENDPOINT.write(WriteBuffer.wrap(zipkinBytes, 0), ZIPKIN_SPAN.localEndpoint());\n Span wireSpan = new Span.Builder().local_endpoint(PROTO_SPAN.local_endpoint).build();\n\n assertThat(zipkinBytes)\n .containsExactly(wireSpan.encode());\n }\n\n @Test void remoteEndpoint_write_matchesWire() {\n byte[] zipkinBytes = new byte[REMOTE_ENDPOINT.sizeInBytes(ZIPKIN_SPAN.remoteEndpoint())];\n REMOTE_ENDPOINT.write(WriteBuffer.wrap(zipkinBytes, 0), ZIPKIN_SPAN.remoteEndpoint());\n Span wireSpan = new Span.Builder().remote_endpoint(PROTO_SPAN.remote_endpoint).build();\n\n assertThat(zipkinBytes)\n .containsExactly(wireSpan.encode());\n }\n\n @Test void tag_sizeInBytes_matchesWire() {\n MapEntry entry = entry(\"clnt/finagle.version\", \"6.45.0\");\n Span wireSpan = new Span.Builder().tags(Map.of(entry.key, entry.value)).build();\n\n assertThat(new TagField(TAG_KEY).sizeInBytes(entry))\n .isEqualTo(Span.ADAPTER.encodedSize(wireSpan));\n }\n\n @Test void writeTagField_matchesWire() {\n MapEntry entry = entry(\"clnt/finagle.version\", \"6.45.0\");\n TagField field = new TagField(TAG_KEY);\n byte[] zipkinBytes = new byte[field.sizeInBytes(entry)];\n field.write(WriteBuffer.wrap(zipkinBytes, 0), entry);\n\n Span oneField = new Span.Builder().tags(Map.of(entry.key, entry.value)).build();\n assertThat(zipkinBytes)\n .containsExactly(oneField.encode());\n }\n\n @Test void writeTagField_matchesWire_emptyValue() {\n MapEntry entry = entry(\"error\", \"\");\n TagField field = new TagField(TAG_KEY);\n byte[] zipkinBytes = new byte[field.sizeInBytes(entry)];\n field.write(WriteBuffer.wrap(zipkinBytes, 0), entry);\n\n Span oneField = new Span.Builder().tags(Map.of(entry.key, entry.value)).build();\n assertThat(zipkinBytes)\n .containsExactly(oneField.encode());\n }\n\n static zipkin2.Span.Builder zipkinSpanBuilder() {\n return zipkin2.Span.newBuilder().traceId(\"a\").id(\"a\");\n }\n}\n" }, { "path": "benchmarks/src/test/java/zipkin2/internal/ReadBufferBenchmarks.java", "content": "/*\n * Copyright The OpenZipkin Authors\n * SPDX-License-Identifier: Apache-2.0\n */\npackage zipkin2.internal;\n\nimport java.util.concurrent.TimeUnit;\nimport org.openjdk.jmh.annotations.Benchmark;\nimport org.openjdk.jmh.annotations.BenchmarkMode;\nimport org.openjdk.jmh.annotations.Fork;\nimport org.openjdk.jmh.annotations.Measurement;\nimport org.openjdk.jmh.annotations.Mode;\nimport org.openjdk.jmh.annotations.OutputTimeUnit;\nimport org.openjdk.jmh.annotations.Scope;\nimport org.openjdk.jmh.annotations.State;\nimport org.openjdk.jmh.annotations.Threads;\nimport org.openjdk.jmh.annotations.Warmup;\nimport org.openjdk.jmh.runner.Runner;\nimport org.openjdk.jmh.runner.RunnerException;\nimport org.openjdk.jmh.runner.options.Options;\nimport org.openjdk.jmh.runner.options.OptionsBuilder;\n\n@Measurement(iterations = 5, time = 1)\n@Warmup(iterations = 10, time = 1)\n@Fork(3)\n@BenchmarkMode(Mode.SampleTime)\n@OutputTimeUnit(TimeUnit.MICROSECONDS)\n@State(Scope.Thread)\n@Threads(1)\npublic class ReadBufferBenchmarks {\n byte[] longBuff = {\n (byte) 0x01, (byte) 0x02, (byte) 0x03, (byte) 0x04,\n (byte) 0x05, (byte) 0x06, (byte) 0x07, (byte) 0x08,\n };\n\n @Benchmark public long readLong() {\n int pos = 0;\n return (longBuff[pos] & 0xffL) << 56\n | (longBuff[pos + 1] & 0xffL) << 48\n | (longBuff[pos + 2] & 0xffL) << 40\n | (longBuff[pos + 3] & 0xffL) << 32\n | (longBuff[pos + 4] & 0xffL) << 24\n | (longBuff[pos + 5] & 0xffL) << 16\n | (longBuff[pos + 6] & 0xffL) << 8\n | (longBuff[pos + 7] & 0xffL);\n }\n\n @Benchmark public long readLong_localArray() {\n int pos = 0;\n byte[] longBuff = this.longBuff;\n return (longBuff[pos] & 0xffL) << 56\n | (longBuff[pos + 1] & 0xffL) << 48\n | (longBuff[pos + 2] & 0xffL) << 40\n | (longBuff[pos + 3] & 0xffL) << 32\n | (longBuff[pos + 4] & 0xffL) << 24\n | (longBuff[pos + 5] & 0xffL) << 16\n | (longBuff[pos + 6] & 0xffL) << 8\n | (longBuff[pos + 7] & 0xffL);\n }\n\n @Benchmark public long readLong_8arity_localArray() {\n int pos = 0;\n return readLong(\n longBuff[pos] & 0xff,\n longBuff[pos + 1] & 0xff,\n longBuff[pos + 2] & 0xff,\n longBuff[pos + 3] & 0xff,\n longBuff[pos + 4] & 0xff,\n longBuff[pos + 5] & 0xff,\n longBuff[pos + 6] & 0xff,\n longBuff[pos + 7] & 0xff\n );\n }\n\n @Benchmark public long readLong_8arity() {\n int pos = 0;\n byte[] longBuff = this.longBuff;\n return readLong(\n longBuff[pos] & 0xff,\n longBuff[pos + 1] & 0xff,\n longBuff[pos + 2] & 0xff,\n longBuff[pos + 3] & 0xff,\n longBuff[pos + 4] & 0xff,\n longBuff[pos + 5] & 0xff,\n longBuff[pos + 6] & 0xff,\n longBuff[pos + 7] & 0xff\n );\n }\n\n static long readLong(int p0, int p1, int p2, int p3, int p4, int p5, int p6, int p7) {\n return (p0 & 0xffL) << 56\n | (p1 & 0xffL) << 48\n | (p2 & 0xffL) << 40\n | (p3 & 0xffL) << 32\n | (p4 & 0xffL) << 24\n | (p5 & 0xffL) << 16\n | (p6 & 0xffL) << 8\n | (p7 & 0xffL);\n }\n\n @Benchmark public long readLongReverseBytes() {\n return Long.reverseBytes(readLong());\n }\n\n // Convenience main entry-point\n public static void main(String[] args) throws RunnerException {\n Options opt = new OptionsBuilder()\n .include(\".*\" + ReadBufferBenchmarks.class.getSimpleName() + \".*\")\n .addProfiler(\"gc\")\n .build();\n\n new Runner(opt).run();\n }\n}\n" }, { "path": "benchmarks/src/test/java/zipkin2/internal/WriteBufferBenchmarks.java", "content": "/*\n * Copyright The OpenZipkin Authors\n * SPDX-License-Identifier: Apache-2.0\n */\npackage zipkin2.internal;\n\nimport java.nio.ByteBuffer;\nimport java.util.concurrent.TimeUnit;\nimport org.openjdk.jmh.annotations.Benchmark;\nimport org.openjdk.jmh.annotations.BenchmarkMode;\nimport org.openjdk.jmh.annotations.Fork;\nimport org.openjdk.jmh.annotations.Measurement;\nimport org.openjdk.jmh.annotations.Mode;\nimport org.openjdk.jmh.annotations.OutputTimeUnit;\nimport org.openjdk.jmh.annotations.Scope;\nimport org.openjdk.jmh.annotations.State;\nimport org.openjdk.jmh.annotations.Threads;\nimport org.openjdk.jmh.annotations.Warmup;\nimport org.openjdk.jmh.runner.Runner;\nimport org.openjdk.jmh.runner.RunnerException;\nimport org.openjdk.jmh.runner.options.Options;\nimport org.openjdk.jmh.runner.options.OptionsBuilder;\n\nimport static java.nio.charset.StandardCharsets.UTF_8;\n\n@Measurement(iterations = 5, time = 1)\n@Warmup(iterations = 10, time = 1)\n@Fork(3)\n@BenchmarkMode(Mode.AverageTime)\n@OutputTimeUnit(TimeUnit.MICROSECONDS)\n@State(Scope.Thread)\n@Threads(1)\npublic class WriteBufferBenchmarks {\n // Order id = d07c4daa-0fa9-4c03-90b1-e06c4edae250 doesn't exist\n static final String CHINESE_UTF8 = \"订单d07c4daa-0fa9-4c03-90b1-e06c4edae250不存在\";\n static final int CHINESE_UTF8_SIZE = UTF_8.encode(CHINESE_UTF8).remaining();\n /* length-prefixing a 1 KiB span */\n static final int TEST_INT = 1024;\n /* epoch micros timestamp */\n static final long TEST_LONG = 1472470996199000L;\n byte[] bytes = new byte[8];\n WriteBuffer buffer = WriteBuffer.wrap(bytes);\n\n @Benchmark public int utf8SizeInBytes_chinese() {\n return WriteBuffer.utf8SizeInBytes(CHINESE_UTF8);\n }\n\n @Benchmark public byte[] writeUtf8_chinese() {\n byte[] bytesUtf8 = new byte[CHINESE_UTF8_SIZE];\n WriteBuffer.wrap(bytesUtf8, 0).writeUtf8(CHINESE_UTF8);\n return bytesUtf8;\n }\n\n @Benchmark public ByteBuffer writeUtf8_chinese_jdk() {\n return UTF_8.encode(CHINESE_UTF8);\n }\n\n @Benchmark public int varIntSizeInBytes_32() {\n return WriteBuffer.varintSizeInBytes(TEST_INT);\n }\n\n @Benchmark public int varIntSizeInBytes_64() {\n return WriteBuffer.varintSizeInBytes(TEST_LONG);\n }\n\n @Benchmark public int writeVarint_32() {\n buffer.writeVarint(TEST_INT);\n return buffer.pos();\n }\n\n @Benchmark public int writeVarint_64() {\n buffer.writeVarint(TEST_LONG);\n return buffer.pos();\n }\n\n @Benchmark public int writeLongLe() {\n buffer.writeLongLe(TEST_LONG);\n return buffer.pos();\n }\n\n // Convenience main entry-point\n public static void main(String[] args) throws RunnerException {\n Options opt = new OptionsBuilder()\n .include(\".*\" + WriteBufferBenchmarks.class.getSimpleName() + \".*\")\n .build();\n\n new Runner(opt).run();\n }\n}\n" }, { "path": "benchmarks/src/test/java/zipkin2/server/ServerIntegratedBenchmark.java", "content": "/*\n * Copyright The OpenZipkin Authors\n * SPDX-License-Identifier: Apache-2.0\n */\npackage zipkin2.server;\n\nimport com.fasterxml.jackson.databind.ObjectMapper;\nimport com.linecorp.armeria.client.WebClient;\nimport io.netty.handler.codec.http.QueryStringEncoder;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Path;\nimport java.nio.file.Paths;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.LinkedHashMap;\nimport java.util.List;\nimport java.util.Map;\nimport java.util.stream.Collectors;\nimport java.util.stream.Stream;\nimport javax.annotation.Nullable;\nimport org.junit.jupiter.api.AfterEach;\nimport org.junit.jupiter.api.BeforeEach;\nimport org.junit.jupiter.api.Disabled;\nimport org.junit.jupiter.api.Test;\nimport org.slf4j.Logger;\nimport org.slf4j.LoggerFactory;\nimport org.testcontainers.containers.GenericContainer;\nimport org.testcontainers.containers.Network;\nimport org.testcontainers.containers.output.Slf4jLogConsumer;\nimport org.testcontainers.containers.wait.strategy.Wait;\nimport org.testcontainers.lifecycle.Startables;\nimport org.testcontainers.utility.MountableFile;\n\nimport static org.testcontainers.utility.DockerImageName.parse;\n\n/**\n * This benchmark runs zipkin-server, storage backends, an example application, prometheus, grafana,\n * and wrk using docker to generate a performance report.\n *\n *

Currently there are two environment variable knobs\n *\n *

    \n *
  • \n * RELEASE_VERSION - specify to a released zipkin server. If unspecified, will use the current code,\n * i.e., the code currently displayed in your IDE.\n *
    • \n *
  • \n * ZIPKIN_BENCHMARK_WAIT - set to true to have the benchmark wait until user manually terminates at the end.\n * Useful to manually inspect prometheus / grafana.\n *
    • \n *
\n *\n *

Note to Windows laptop users: you will probably need to restart the Docker daemon before a\n * session of benchmarks. Docker containers seem to have time get out of sync when a computer sleeps\n * until you restart the daemon - this causes Prometheus metrics to not scrape properly.\n */\n@Disabled // Run manually\nclass ServerIntegratedBenchmark {\n static final Logger LOG = LoggerFactory.getLogger(ServerIntegratedBenchmark.class);\n\n static final ObjectMapper OBJECT_MAPPER = new ObjectMapper();\n\n @Nullable static final String RELEASE_VERSION = System.getenv(\"RELEASE_VERSION\");\n\n static final boolean WAIT_AFTER_BENCHMARK = \"true\".equals(System.getenv(\"ZIPKIN_BENCHMARK_WAIT\"));\n\n List> containers;\n\n @BeforeEach void setUp() {\n containers = new ArrayList<>();\n }\n\n @AfterEach void tearDown() {\n containers.forEach(GenericContainer::stop);\n }\n\n @Test void inMemory() throws Exception {\n runBenchmark(null);\n }\n\n @Test void elasticsearch() throws Exception {\n GenericContainer elasticsearch =\n new GenericContainer<>(parse(\"ghcr.io/openzipkin/zipkin-elasticsearch7:3.4.3\"))\n .withNetwork(Network.SHARED)\n .withNetworkAliases(\"elasticsearch\")\n .withLabel(\"name\", \"elasticsearch\")\n .withLabel(\"storageType\", \"elasticsearch\")\n .withExposedPorts(9200)\n .waitingFor(Wait.forHealthcheck());\n containers.add(elasticsearch);\n\n runBenchmark(elasticsearch);\n }\n\n @Test void cassandra3() throws Exception {\n GenericContainer cassandra =\n new GenericContainer<>(parse(\"ghcr.io/openzipkin/zipkin-cassandra:3.4.3\"))\n .withNetwork(Network.SHARED)\n .withNetworkAliases(\"cassandra\")\n .withLabel(\"name\", \"cassandra\")\n .withLabel(\"storageType\", \"cassandra3\")\n .withExposedPorts(9042)\n .waitingFor(Wait.forHealthcheck());\n containers.add(cassandra);\n\n runBenchmark(cassandra);\n }\n\n @Test void mysql() throws Exception {\n GenericContainer mysql =\n new GenericContainer<>(parse(\"ghcr.io/openzipkin/zipkin-mysql:3.4.3\"))\n .withNetwork(Network.SHARED)\n .withNetworkAliases(\"mysql\")\n .withLabel(\"name\", \"mysql\")\n .withLabel(\"storageType\", \"mysql\")\n .withExposedPorts(3306)\n .waitingFor(Wait.forHealthcheck());\n containers.add(mysql);\n\n runBenchmark(mysql);\n }\n\n void runBenchmark(@Nullable GenericContainer storage) throws Exception {\n runBenchmark(storage, createZipkinContainer(storage));\n }\n\n void runBenchmark(@Nullable GenericContainer storage, GenericContainer zipkin)\n throws Exception {\n GenericContainer backend =\n new GenericContainer<>(parse(\"ghcr.io/openzipkin/brave-example:armeria\"))\n .withNetwork(Network.SHARED)\n .withNetworkAliases(\"backend\")\n .withCommand(\"backend\")\n .withExposedPorts(9000)\n .waitingFor(Wait.forHealthcheck());\n\n GenericContainer frontend =\n new GenericContainer<>(parse(\"ghcr.io/openzipkin/brave-example:armeria\"))\n .withNetwork(Network.SHARED)\n .withNetworkAliases(\"frontend\")\n .withCommand(\"frontend\")\n .withExposedPorts(8081)\n .waitingFor(Wait.forHealthcheck());\n containers.add(frontend);\n\n // Use a quay.io mirror to prevent build outages due to Docker Hub pull quotas\n // Use same version as in docker/examples/docker-compose-prometheus.yml\n GenericContainer prometheus =\n new GenericContainer<>(parse(\"quay.io/prometheus/prometheus:v2.55.1\"))\n .withNetwork(Network.SHARED)\n .withNetworkAliases(\"prometheus\")\n .withExposedPorts(9090)\n .withCopyFileToContainer(\n MountableFile.forClasspathResource(\"prometheus.yml\"), \"/etc/prometheus/prometheus.yml\");\n containers.add(prometheus);\n\n // Use a quay.io mirror to prevent build outages due to Docker Hub pull quotas\n // Use same version as in docker/examples/docker-compose-prometheus.yml\n GenericContainer grafana = new GenericContainer<>(parse(\"quay.io/giantswarm/grafana:7.5.12\"))\n .withNetwork(Network.SHARED)\n .withNetworkAliases(\"grafana\")\n .withExposedPorts(3000)\n .withEnv(\"GF_AUTH_ANONYMOUS_ENABLED\", \"true\")\n .withEnv(\"GF_AUTH_ANONYMOUS_ORG_ROLE\", \"Admin\");\n containers.add(grafana);\n\n // This is an arbitrary small image that has curl installed\n // Use a quay.io mirror to prevent build outages due to Docker Hub pull quotas\n // Use same version as in docker/examples/docker-compose-prometheus.yml\n GenericContainer grafanaDashboards =\n new GenericContainer<>(parse(\"quay.io/cilium/alpine-curl:v1.10.0\"))\n .withNetwork(Network.SHARED)\n .withWorkingDirectory(\"/tmp\")\n .withLogConsumer(new Slf4jLogConsumer(LOG))\n .withCreateContainerCmdModifier(it -> it.withEntrypoint(\"/tmp/create.sh\"))\n .withCopyFileToContainer(\n MountableFile.forClasspathResource(\"create-datasource-and-dashboard.sh\", 555),\n \"/tmp/create.sh\");\n containers.add(grafanaDashboards);\n\n // Use a quay.io mirror to prevent build outages due to Docker Hub pull quotas\n GenericContainer wrk = new GenericContainer<>(parse(\"quay.io/dim/wrk:stable\"))\n .withNetwork(Network.SHARED)\n .withCreateContainerCmdModifier(it -> it.withEntrypoint(\"wrk\"))\n .withCommand(\"-t4 -c128 -d100s http://frontend:8081 --latency\");\n containers.add(wrk);\n\n grafanaDashboards.dependsOn(grafana);\n wrk.dependsOn(frontend, backend, prometheus, grafanaDashboards, zipkin);\n if (storage != null) wrk.dependsOn(storage);\n\n Startables.deepStart(Stream.of(wrk)).join();\n\n System.out.println(\"Benchmark started.\");\n if (zipkin != null) printContainerMapping(zipkin);\n if (storage != null) printContainerMapping(storage);\n printContainerMapping(backend);\n printContainerMapping(frontend);\n printContainerMapping(prometheus);\n printContainerMapping(grafana);\n\n while (wrk.isRunning()) {\n Thread.sleep(1000);\n }\n\n // Wait for prometheus to do a final scrape.\n Thread.sleep(5000);\n\n System.out.println(\"Benchmark complete, wrk output:\");\n System.out.println(wrk.getLogs().replace(\"\\n\\n\", \"\\n\"));\n\n WebClient prometheusClient = WebClient.of(\n \"h1c://\" + prometheus.getContainerIpAddress() + \":\" + prometheus.getFirstMappedPort());\n\n System.out.printf(\"Messages received: %s%n\", prometheusValue(\n prometheusClient, \"sum(zipkin_collector_messages_total)\"));\n System.out.printf(\"Spans received: %s%n\", prometheusValue(\n prometheusClient, \"sum(zipkin_collector_spans_total)\"));\n System.out.printf(\"Spans dropped: %s%n\", prometheusValue(\n prometheusClient, \"sum(zipkin_collector_spans_dropped_total)\"));\n\n System.out.println(\"Memory quantiles:\");\n printQuartiles(prometheusClient, \"jvm_memory_used_bytes{area=\\\"heap\\\"}\");\n printQuartiles(prometheusClient, \"jvm_memory_used_bytes{area=\\\"nonheap\\\"}\");\n\n System.out.printf(\n \"Total GC time (s): %s%n\",\n prometheusValue(prometheusClient, \"sum(jvm_gc_pause_seconds_sum)\"));\n System.out.printf(\n \"Number of GCs: %s%n\", prometheusValue(prometheusClient, \"sum(jvm_gc_pause_seconds_count)\"));\n\n System.out.println(\"POST Spans latency (s)\");\n printHistogram(prometheusClient, \"\"\"\n http_server_requests_seconds_bucket{\n method=\"POST\",status=\"202\",uri=\"/api/v2/spans\"}\n \"\"\");\n\n if (WAIT_AFTER_BENCHMARK) {\n System.out.println(\"\"\"\n Keeping containers running until explicit termination. \\\n Feel free to poke around in grafana.\\\n \"\"\");\n Thread.sleep(Long.MAX_VALUE);\n }\n }\n\n GenericContainer createZipkinContainer(@Nullable GenericContainer storage)\n throws Exception {\n Map env = new LinkedHashMap<>();\n if (storage != null) {\n String name = storage.getLabels().get(\"name\");\n String host = name;\n int port = storage.getExposedPorts().get(0);\n String address = host + \":\" + port;\n\n env.put(\"STORAGE_TYPE\", storage.getLabels().get(\"storageType\"));\n switch (name) {\n case \"elasticsearch\":\n env.put(\"ES_HOSTS\", \"http://\" + address);\n break;\n case \"cassandra\":\n case \"cassandra3\":\n env.put(\"CASSANDRA_CONTACT_POINTS\", address);\n break;\n case \"mysql\":\n env.put(\"MYSQL_HOST\", host);\n env.put(\"MYSQL_TCP_PORT\", Integer.toString(port));\n env.put(\"MYSQL_USER\", \"zipkin\");\n env.put(\"MYSQL_PASS\", \"zipkin\");\n break;\n default:\n throw new IllegalArgumentException(\"Unknown storage \" + name +\n \". Update startZipkin to map it to properties.\");\n }\n }\n\n final GenericContainer zipkin;\n if (RELEASE_VERSION == null) {\n zipkin = new GenericContainer<>(parse(\"ghcr.io/openzipkin/java:21.0.6_p7\"));\n List classpath = new ArrayList<>();\n for (String item : System.getProperty(\"java.class.path\").split(File.pathSeparator)) {\n Path path = Paths.get(item);\n final String containerPath;\n if (Files.isDirectory(path)) {\n Path root = path.getParent();\n while (root != null) {\n try (Stream f = Files.list(root)) {\n if (f.anyMatch(p -> p.getFileName().toString().equals(\"mvnw\"))) {\n break;\n }\n }\n root = root.getParent();\n }\n containerPath = root.relativize(path).toString().replace('\\\\', '/');\n } else {\n containerPath = path.getFileName().toString();\n }\n // Test containers currently doesn't support copying in a path with subdirectories that\n // need to be created, so we mangle directory structure into a single directory with\n // hyphens.\n String classPathItem = \"/classpath-\" + containerPath.replace('/', '-');\n zipkin.withCopyFileToContainer(MountableFile.forHostPath(item), classPathItem);\n classpath.add(classPathItem);\n }\n zipkin.withCreateContainerCmdModifier(cmd -> cmd.withEntrypoint(\"java\"));\n zipkin.setCommand(\"-cp\", String.join(\":\", classpath), \"zipkin.server.ZipkinServer\");\n // Don't fail on classpath problem from missing lens, as we don't use it.\n env.put(\"ZIPKIN_UI_ENABLED\", \"false\");\n } else {\n zipkin = new GenericContainer<>(parse(\"ghcr.io/openzipkin/zipkin:\" + RELEASE_VERSION));\n }\n\n zipkin\n .withNetwork(Network.SHARED)\n .withNetworkAliases(\"zipkin\")\n .withExposedPorts(9411)\n .withEnv(env)\n .waitingFor(Wait.forHttp(\"/health\"));\n containers.add(zipkin);\n return zipkin;\n }\n\n static void printContainerMapping(GenericContainer container) {\n System.out.printf(\n \"Container %s ports exposed at %s%n\", container.getDockerImageName(),\n container.getExposedPorts().stream()\n .map(port -> Map.entry(port,\n \"http://\" + container.getContainerIpAddress() + \":\" + container.getMappedPort(port)))\n .collect(Collectors.toMap(Map.Entry::getKey, Map.Entry::getValue)));\n }\n\n static void printQuartiles(WebClient prometheus, String metric) throws Exception {\n for (double quantile : Arrays.asList(0.0, 0.25, 0.5, 0.75, 1.0)) {\n String value = prometheusValue(prometheus, \"quantile(\" + quantile + \", \" + metric + \")\");\n System.out.printf(\"%s[%s] = %s%n\", metric, quantile, value);\n }\n }\n\n static void printHistogram(WebClient prometheus, String metric) throws Exception {\n for (double quantile : Arrays.asList(0.5, 0.9, 0.99)) {\n String value =\n prometheusValue(prometheus, \"histogram_quantile(\" + quantile + \", \" + metric + \")\");\n System.out.printf(\"%s[%s] = %s%n\", metric, quantile, value);\n }\n }\n\n static String prometheusValue(WebClient prometheus, String query) throws Exception {\n QueryStringEncoder encoder = new QueryStringEncoder(\"/api/v1/query\");\n encoder.addParam(\"query\", query);\n String response = prometheus.get(encoder.toString()).aggregate().join().contentUtf8();\n return OBJECT_MAPPER.readTree(response).at(\"/data/result/0/value/1\").asText();\n }\n}\n" }, { "path": "benchmarks/src/test/java/zipkin2/server/internal/throttle/ThrottledCallBenchmarks.java", "content": "/*\n * Copyright The OpenZipkin Authors\n * SPDX-License-Identifier: Apache-2.0\n */\npackage zipkin2.server.internal.throttle;\n\nimport com.linecorp.armeria.common.metric.NoopMeterRegistry;\nimport com.netflix.concurrency.limits.limit.FixedLimit;\nimport com.netflix.concurrency.limits.limiter.SimpleLimiter;\nimport java.io.IOException;\nimport java.util.concurrent.Executor;\nimport java.util.concurrent.ExecutorService;\nimport java.util.concurrent.Executors;\nimport java.util.concurrent.RejectedExecutionException;\nimport java.util.concurrent.TimeUnit;\nimport java.util.function.Predicate;\nimport org.openjdk.jmh.annotations.Benchmark;\nimport org.openjdk.jmh.annotations.BenchmarkMode;\nimport org.openjdk.jmh.annotations.Fork;\nimport org.openjdk.jmh.annotations.Measurement;\nimport org.openjdk.jmh.annotations.Mode;\nimport org.openjdk.jmh.annotations.OutputTimeUnit;\nimport org.openjdk.jmh.annotations.Scope;\nimport org.openjdk.jmh.annotations.Setup;\nimport org.openjdk.jmh.annotations.State;\nimport org.openjdk.jmh.annotations.TearDown;\nimport org.openjdk.jmh.annotations.Threads;\nimport org.openjdk.jmh.annotations.Warmup;\nimport org.openjdk.jmh.runner.Runner;\nimport org.openjdk.jmh.runner.RunnerException;\nimport org.openjdk.jmh.runner.options.Options;\nimport org.openjdk.jmh.runner.options.OptionsBuilder;\nimport zipkin2.Call;\nimport zipkin2.Callback;\n\n@Measurement(iterations = 5, time = 1)\n@Warmup(iterations = 10, time = 1)\n@Fork(3)\n@BenchmarkMode(Mode.SampleTime)\n@OutputTimeUnit(TimeUnit.MICROSECONDS)\n@State(Scope.Thread)\n@Threads(2)\npublic class ThrottledCallBenchmarks {\n ExecutorService fakeCallExecutor = Executors.newSingleThreadExecutor();\n ExecutorService executor = Executors.newSingleThreadExecutor();\n ThrottledCall call;\n\n @Setup public void setup() {\n executor = Executors.newSingleThreadExecutor();\n fakeCallExecutor = Executors.newSingleThreadExecutor();\n SimpleLimiter limiter = SimpleLimiter.newBuilder().limit(FixedLimit.of(1)).build();\n LimiterMetrics metrics = new LimiterMetrics(NoopMeterRegistry.get());\n Predicate isOverCapacity = RejectedExecutionException.class::isInstance;\n call =\n new ThrottledCall(new FakeCall(fakeCallExecutor), executor, limiter, metrics, isOverCapacity);\n }\n\n @TearDown public void tearDown() {\n executor.shutdown();\n fakeCallExecutor.shutdown();\n }\n\n @Benchmark public Object execute() throws IOException {\n return call.clone().execute();\n }\n\n @Benchmark public void execute_overCapacity() throws IOException {\n ThrottledCall overCapacity = (ThrottledCall) call.clone();\n ((FakeCall) overCapacity.delegate).overCapacity = true;\n\n try {\n overCapacity.execute();\n } catch (RejectedExecutionException e) {\n assert e == OVER_CAPACITY;\n }\n }\n\n @Benchmark public void execute_throttled() throws IOException {\n call.limiter.acquire(null); // capacity is 1, so this will overdo it.\n call.clone().execute();\n }\n\n static final RejectedExecutionException OVER_CAPACITY = new RejectedExecutionException();\n\n static final class FakeCall extends Call.Base {\n final Executor executor;\n boolean overCapacity = false;\n\n FakeCall(Executor executor) {\n this.executor = executor;\n }\n\n @Override public Void doExecute() throws IOException {\n if (overCapacity) throw OVER_CAPACITY;\n return null;\n }\n\n @Override public void doEnqueue(Callback callback) {\n executor.execute(() -> {\n if (overCapacity) {\n callback.onError(OVER_CAPACITY);\n } else {\n callback.onSuccess(null);\n }\n });\n }\n\n @Override public FakeCall clone() {\n return new FakeCall(executor);\n }\n }\n\n // Convenience main entry-point\n public static void main(String[] args) throws RunnerException {\n Options opt = new OptionsBuilder()\n .addProfiler(\"gc\")\n .include(\".*\" + ThrottledCallBenchmarks.class.getSimpleName())\n .build();\n\n new Runner(opt).run();\n }\n}\n" }, { "path": "benchmarks/src/test/resources/create-datasource-and-dashboard.sh", "content": "#!/bin/sh\n#\n# Copyright The OpenZipkin Authors\n# SPDX-License-Identifier: Apache-2.0\n#\n\nset -xeuo pipefail\n\nif ! curl --retry 5 --retry-connrefused --retry-delay 0 -sf http://grafana:3000/api/datasources/name/prom; then\n curl -sf -X POST -H \"Content-Type: application/json\" \\\n --data-binary '{\"name\":\"prom\",\"type\":\"prometheus\",\"url\":\"http://prometheus:9090\",\"access\":\"proxy\",\"isDefault\":true}' \\\n http://grafana:3000/api/datasources\nfi\n\ndashboard_id=1598\nlast_revision=$(curl -sf https://grafana.com/api/dashboards/${dashboard_id}/revisions | grep '\"revision\":' | sed 's/ *\"revision\": \\([0-9]*\\),/\\1/' | sort -n | tail -1)\n\necho '{\"dashboard\": ' > data.json\ncurl -s https://grafana.com/api/dashboards/${dashboard_id}/revisions/${last_revision}/download >> data.json\necho ', \"inputs\": [{\"name\": \"DS_PROMETHEUS\", \"pluginId\": \"prometheus\", \"type\": \"datasource\", \"value\": \"prom\"}], \"overwrite\": false}' >> data.json\ncurl --retry-connrefused --retry 5 --retry-delay 0 -sf \\\n -X POST -H \"Content-Type: application/json\" \\\n --data-binary @data.json \\\n http://grafana:3000/api/dashboards/import\n" }, { "path": "benchmarks/src/test/resources/prometheus.yml", "content": "global:\n scrape_interval: 15s # Set the scrape interval to every 15 seconds. Default is every 1 minute.\n evaluation_interval: 15s # Evaluate rules every 15 seconds. The default is every 1 minute.\n\nscrape_configs:\n - job_name: 'prometheus'\n static_configs:\n - targets: ['localhost:9090']\n - job_name: 'zipkin'\n scrape_interval: 5s\n metrics_path: '/prometheus'\n static_configs:\n - targets: ['zipkin:9411']\n" }, { "path": "benchmarks/src/test/resources/simplelogger.properties", "content": "# See https://www.slf4j.org/api/org/slf4j/impl/SimpleLogger.html for the full list of config options\n\norg.slf4j.simpleLogger.logFile=System.out\norg.slf4j.simpleLogger.defaultLogLevel=warn\norg.slf4j.simpleLogger.showDateTime=true\norg.slf4j.simpleLogger.dateTimeFormat=yyyy-MM-dd HH:mm:ss:SSS\n\n# uncomment to include kafka consumer configuration in test logs\n#logger.org.apache.kafka.clients.level=info\n" }, { "path": "benchmarks/src/test/resources/zipkin2-chinese.json", "content": "{\n \"traceId\": \"4d1e00c0db9010db86154a4ba6e91385\",\n \"parentId\": \"86154a4ba6e91385\",\n \"id\": \"4d1e00c0db9010db\",\n \"kind\": \"CLIENT\",\n \"name\": \"个人信息查询\",\n \"timestamp\": 1472470996199000,\n \"duration\": 207000,\n \"localEndpoint\": {\n \"serviceName\": \"订单维护服务\",\n \"ipv6\": \"2001:db8::c001\"\n },\n \"remoteEndpoint\": {\n \"serviceName\": \"个人信息服务\",\n \"ipv4\": \"192.168.99.101\",\n \"port\": 9000\n },\n \"tags\": {\n \"http.path\": \"/person/profile/query\",\n \"http.status_code\": \"403\",\n \"error\": \"此用户没有操作权限\"\n }\n}\n" }, { "path": "benchmarks/src/test/resources/zipkin2-client.json", "content": "{\n \"traceId\": \"4d1e00c0db9010db86154a4ba6e91385\",\n \"parentId\": \"86154a4ba6e91385\",\n \"id\": \"4d1e00c0db9010db\",\n \"kind\": \"CLIENT\",\n \"name\": \"get\",\n \"timestamp\": 1472470996199000,\n \"duration\": 207000,\n \"localEndpoint\": {\n \"serviceName\": \"frontend\",\n \"ipv6\": \"2001:db8::c001\"\n },\n \"remoteEndpoint\": {\n \"serviceName\": \"backend\",\n \"ipv4\": \"192.168.99.101\",\n \"port\": 9000\n },\n \"annotations\": [\n {\n \"timestamp\": 1472470996238000,\n \"value\": \"foo\"\n },\n {\n \"timestamp\": 1472470996403000,\n \"value\": \"bar\"\n }\n ],\n \"tags\": {\n \"http.path\": \"/api\",\n \"clnt/finagle.version\": \"6.45.0\"\n }\n}\n" }, { "path": "build-bin/README.md", "content": "# Test and Deploy scripts\n\nThis is a Maven+Docker project, which uses standard conventions for test and deploy with some\nexceptions.\n\nOn [../zipkin-lens]:\n* [maybe_install_npm] is used to build on an unsupported node.js architecture.\n* [maven_go_offline] additionally seeds the NPM cache\n\nOn test:\n* [test], used by [../.github/workflows/test.yml] runs Maven unit and integration tests.\n * Its \"test\" job skips docker, as they are run in parallel in \"test_docker\"\n* [../.github/workflows/readme_test.yml] tests build commands in [../zipkin-server] and [../docker]\n * zipkin, zipkin-lens and zipkin-slim Docker builds use `RELEASE_FROM_MAVEN_BUILD=true`\n * this avoids invoking Maven builds from within Docker, which are costly and fragile\n * Docker tests run in sequence to avoid queueing delays, which take longer than builds themselves.\n\nOn deploy:\n* [deploy], used by [../.github/workflows/deploy.yml] publishes jars and Docker images.\n* [javadoc_to_gh_pages] pushes Javadoc to the gh-pages branch on MAJOR.MINOR.PATCH branch, but not master.\n * gh-pages is addressable via https://zipkin.io/zipkin/\n* Besides production Docker images, this project includes [../docker/test-images].\n * [docker_push] pushes test-images, but only to ghcr.io\n\n[//]: # (Below here should be standard for all projects)\n\n## Build Overview\n`build-bin` holds portable scripts used in CI to test and deploy the project.\n\nThe scripts here are portable. They do not include any CI provider-specific logic or ENV variables.\nThis helps `test.yml` (GitHub Actions) and alternatives contain nearly the same contents, even if\ncertain OpenZipkin projects need slight adjustments here. Portability has proven necessary, as\nOpenZipkin has had to transition CI providers many times due to feature and quota constraints.\n\nThese scripts serve a second purpose, which is to facilitate manual releases, which has also\nhappened many times due usually to service outages of CI providers. While tempting to use\nCI-provider specific tools, doing so can easily create a dependency where no one knows how to\nrelease anymore. Do not use provider-specific mechanisms to implement release flow. Instead,\nautomate triggering of the scripts here.\n\nThe only scripts that should be modified per project are in the base directory. Those in\nsubdirectories, such as [docker](docker), should not vary project to project except accident of\nversion drift. Intentional changes in subdirectories should be relevant and tested on multiple\nprojects to ensure they can be blindly copy/pasted.\n\nConversely, the files in the base directory are project specific entry-points for test and deploy\nactions and are entirely appropriate to vary per project. Here's an overview:\n\n## Lint\n\nLint makes sure that documentation and workflows are in-tact. CI providers should be configured to\nrun lint on pull requests or pushes to the master branch, notably when the tag is blank. Linters\nshould only run on documentation-only commits or those who affect workflow files. Linters must not\ndepend on authenticated resources, as running lint can leak credentials.\n\n* [configure_lint](configure_lint) - Ensures linters are installed\n* [lint](lint) - Runs the linters\n\nWe minimally check the following:\n\n* [markdown-link-check](https://github.com/tcort/markdown-link-check) on our Markdown content.\n * we maintain [mlc_config.json](mlc_config.json) for exceptions\n* [yamllint](https://github.com/adrienverge/yamllint) on our GitHub Actions Workflow YAML.\n * occasionally need line length exceptions via `# yamllint disable-line rule:line-length`\n\n### Example GitHub Actions setup\n\nA simplest GitHub Actions `lint.yml` runs linters after configuring them, but only on relevant event\nconditions. The name `lint.yml` and job `lint` allows easy references to status badges and parity of\nthe scripts it uses.\n\nThe `on:` section obviates job creation and resource usage for irrelevant events. Notably, GitHub\nActions includes the ability to skip documentation-only jobs.\n\nHere's a partial `lint.yml` including only the aspects mentioned above.\n```yaml\n---\non: # yamllint disable-line rule:truthy\n push: # non-tagged pushes to master\n branches:\n - master\n tags-ignore:\n - '*'\n paths:\n - '**/*.md'\n - '.github/workflows/*.yml'\n - './build-bin/*lint'\n - ./build-bin/mlc_config.json\n pull_request: # pull requests targeted at the master branch.\n branches:\n - master\n paths:\n - '**/*.md'\n - '.github/workflows/*.yml'\n - './build-bin/*lint'\n - ./build-bin/mlc_config.json\n\njobs:\n lint:\n name: Lint\n runs-on: ubuntu-24.04 # newest available distribution, aka noble\n # skip commits made by the release plugin\n if: \"!contains(github.event.head_commit.message, 'maven-release-plugin')\"\n steps:\n - name: Checkout Repository\n uses: actions/checkout@v4\n - name: Lint\n run: |\n build-bin/configure_lint\n build-bin/lint\n```\n\n## Test\n\nTest builds and runs any tests of the project, including integration tests. CI providers should be\nconfigured to run tests on pull requests or pushes to the master branch, notably when the tag is\nblank. Tests should not run on documentation-only commits. Tests must not depend on authenticated\nresources, as running tests can leak credentials.\n\n * [configure_test](configure_test) - Sets up build environment for tests.\n * [test](test) - Builds and runs tests for this project.\n\n### Example GitHub Actions setup\n\nA simplest GitHub Actions `test.yml` runs tests after configuring them, but only on relevant event\nconditions. The name `test.yml` and job `test` allows easy references to status badges and parity of\nthe scripts it uses.\n\nThe `on:` section obviates job creation and resource usage for irrelevant events. Notably, GitHub\nActions includes the ability to skip documentation-only jobs.\n\nHere's a partial `test.yml` including only the aspects mentioned above.\n```yaml\non: # yamllint disable-line rule:truthy\n push: # non-tagged pushes to master\n branches:\n - master\n tags-ignore:\n - '*'\n paths-ignore:\n - '**/*.md'\n - './build-bin/*lint'\n - ./build-bin/mlc_config.json\n pull_request: # pull requests targeted at the master branch.\n branches:\n - master\n paths-ignore:\n - '**/*.md'\n - './build-bin/*lint'\n - ./build-bin/mlc_config.json\n\njobs:\n test:\n steps:\n - name: Checkout Repository\n uses: actions/checkout@v4\n - name: Test\n run: |\n build-bin/configure_test\n build-bin/test\n```\n\n## Deploy\n\nDeploy builds and pushes artifacts to a remote repository for master and release commits on it. CI\nproviders deploy pushes to master on when the tag is blank, but not on documentation-only commits.\nReleases should deploy on version tags (ex `/^[0-9]+\\.[0-9]+\\.[0-9]+/`), without consideration of if\nthe commit is documentation only or not.\n\n * [configure_deploy](configure_deploy) - Sets up environment and logs in.\n * [deploy](deploy) - deploys the project, with arg1 being \"master\" or a release commit like \"1.2.3\"\n\n### Example GitHub Actions setup\n\nA simplest GitHub Actions `deploy.yml` deploys after logging in, but only on relevant event\nconditions. The name `deploy.yml` and job `deploy` allows easy references to status badges and\nparity of the scripts it uses.\n\nThe `on:` section obviates job creation and resource usage for irrelevant events. GitHub Actions\ncannot implement \"master, except documentation only-commits\" in the same file. Hence, deployments of\nmaster will happen even on README change.\n\nHere's a partial `deploy.yml` including only the aspects mentioned above. Notice env variables are\nexplicitly defined and `on.tags` is a [glob pattern](https://docs.github.com/en/free-pro-team@latest/actions/reference/workflow-syntax-for-github-actions#filter-pattern-cheat-sheet).\n\n```yaml\non: # yamllint disable-line rule:truthy\n push:\n branches:\n - master\n # Don't deploy tags because the same commit for MAJOR.MINOR.PATCH is also\n # on master: Redundant deployment of a release version will fail uploading.\n tags-ignore:\n - '*'\n\njobs:\n deploy:\n runs-on: ubuntu-24.04 # newest available distribution, aka noble\n steps:\n - name: Checkout Repository\n uses: actions/checkout@v4\n with:\n fetch-depth: 1 # only needed to get the sha label\n - name: Deploy\n env:\n GH_USER: ${{ secrets.GH_USER }}\n GH_TOKEN: ${{ secrets.GH_TOKEN }}\n run: | # GITHUB_REF = refs/heads/master or refs/tags/MAJOR.MINOR.PATCH\n build-bin/configure_deploy &&\n build-bin/deploy $(echo ${GITHUB_REF} | cut -d/ -f 3)\n```\n" }, { "path": "build-bin/configure_deploy", "content": "#!/bin/sh -ue\n\n# This script sets up anything needed for `./deploy`. Do not assume `configure_test` was called.\n#\n# See [README.md] for an explanation of this and how CI should use it.\nbuild-bin/docker/configure_docker_push\nbuild-bin/gpg/configure_gpg\n\n# When arch isn't amd64 zipkin-lens needs offline install\nbuild-bin/maybe_install_npm\nbuild-bin/maven_go_offline\n\n# openzipkin/zipkin publishes Javadoc to https://zipkin.io/zipkin/ on release\nbuild-bin/git/login_git\n" }, { "path": "build-bin/configure_lint", "content": "#!/bin/sh -ue\n\n# Attempt to install markdown-link-check if absent\n# Pinned until https://github.com/tcort/markdown-link-check/issues/369\nmarkdown-link-check -V || npm install -g markdown-link-check@3.12.2\n\n# Attempt to install yamllint if absent\nyamllint -v || pip install --user yamllint\n" }, { "path": "build-bin/configure_test", "content": "#!/bin/sh -ue\n\n# This script sets up anything needed for `./test`. This should not login to anything, as that\n# should be done in `configure_deploy`.\n#\n# See [README.md] for an explanation of this and how CI should use it.\nbuild-bin/docker/configure_docker\n\n# When arch isn't amd64 zipkin-lens needs offline install\nbuild-bin/maybe_install_npm\nbuild-bin/maven_go_offline\n" }, { "path": "build-bin/deploy", "content": "#!/bin/sh -ue\n\n# This script deploys a master or release version.\n#\n# See [README.md] for an explanation of this and how CI should use it.\nversion=${1:-master}\n\n# Use implicit version when master, if we can..\nif [ \"${version}\" = \"master\" ]; then\n version=$(sed -En 's/.*(.*)<\\/version>.*/\\1/p' pom.xml| head -1)\nfi\n\nbuild-bin/maven/maven_deploy\nexport RELEASE_FROM_MAVEN_BUILD=true\nbuild-bin/docker_push ${version}\n\n# openzipkin/zipkin publishes Javadoc to gh-pages (https://zipkin.io/zipkin/) on release\ncase ${version} in\n *-SNAPSHOT )\n ;;\n * )\n build-bin/javadoc_to_gh_pages ${version}\n ;;\nesac\n" }, { "path": "build-bin/docker/configure_docker", "content": "#!/bin/sh\n#\n# Copyright The OpenZipkin Authors\n# SPDX-License-Identifier: Apache-2.0\n#\n\n# Defends against build outages caused by Docker Hub (docker.io) pull rate limits.\n#\n# It should not login to anything, as that should be done in `configure_docker_push`\n\nset -ue\n\n# The below sets up testcontainers configuration, which will be ignored if it isn't used. Even if\n# this is Docker related, it is coupled to integration tests configuration invoked with Maven.\n# * See https://www.testcontainers.org/supported_docker_environment/image_registry_rate_limiting/\n# * checks.disable=true - saves time and a docker.io pull of alpine\n# * ryuk doesn't count against docker.io rate limits because Docker approved testcontainers as OSS\necho checks.disable=true >> ~/.testcontainers.properties\n\n# We don't use any docker.io images, but add a Google's mirror in case something implicitly does\n# * See https://cloud.google.com/container-registry/docs/pulling-cached-images\necho '{ \"registry-mirrors\": [\"https://mirror.gcr.io\"] }' | sudo tee /etc/docker/daemon.json\nsudo service docker restart\n" }, { "path": "build-bin/docker/configure_docker_push", "content": "#!/bin/sh\n#\n# Copyright The OpenZipkin Authors\n# SPDX-License-Identifier: Apache-2.0\n#\n\n# Ensures Docker is logged in and it can build multi-architecture.\n# This should be used instead of `configure_docker` when a push will occur.\n#\n# This should only happen when we are publishing multi-arch builds, as otherwise the setup could use\n# Docker Hub pull quota and possibly cause a build outage.\n\nset -ue\n\n# Verify we are on an arch that can publish multi-arch images\narch=$($(dirname \"$0\")/docker_arch)\nif [ \"${arch}\" != \"amd64\" ]; then\n >&2 echo \"multiarch/qemu-user-static doesn't support arch ${arch}\"\n exit 1\nfi\n\n# Enable experimental features on the server (multi-arch)\necho '{ \"experimental\":true, \"registry-mirrors\": [\"https://mirror.gcr.io\"] }' | sudo tee /etc/docker/daemon.json\n\nsudo service docker restart\n# Enable experimental client features (multi-arch)\nmkdir -p ${HOME}/.docker && echo '{\"experimental\":\"enabled\"}' > ${HOME}/.docker/config.json\n\n# Log in to GitHub Container Registry and Docker Hub for releasing images\n# This effects ${HOME}/.docker/config.json, which was created above\n\n# All images push to ghcr.io\necho \"${GH_TOKEN}\" | docker login ghcr.io -u \"${GH_USER}\" --password-stdin\n\n# Some images push to docker.io: check first if credentials exist or not.\nif [ -n \"${DOCKERHUB_USER:-}\" ]; then\n echo \"${DOCKERHUB_TOKEN}\" | docker login -u \"${DOCKERHUB_USER}\" --password-stdin\nfi\n\n# Enable execution of different multi-architecture containers by QEMU and binfmt_misc\n# See https://github.com/multiarch/qemu-user-static\n#\n# Mirrored image use to avoid docker.io pulls:\n# docker tag multiarch/qemu-user-static:7.2.0-1 ghcr.io/openzipkin/multiarch-qemu-user-static:latest\n#\n# Note: This image only works on x86_64/amd64 architecture.\n# See: https://github.com/multiarch/qemu-user-static#supported-host-architectures\ndocker run --rm --privileged ghcr.io/openzipkin/multiarch-qemu-user-static --reset -p yes\n" }, { "path": "build-bin/docker/docker-healthcheck", "content": "#!/bin/sh\n#\n# Copyright The OpenZipkin Authors\n# SPDX-License-Identifier: Apache-2.0\n#\n\n# HEALTHCHECK for use in `docker ps`, `docker compose ps`, or a readiness probe in k8s.\n#\n# The following variables are read from ENV in the Dockerfile or env readable from pid 1.\n# * HEALTHCHECK_KIND - must be \"http\" or \"tcp\". Defaults to \"http\"\n# * When \"http\" the GET path to check is /health unless overridden by HEALTHCHECK_PATH\n# * HEALTHCHECK_IP - Defaults to $(hostname -i || 127.0.0.1)\n# * HEALTHCHECK_PORT - Not always the service port, but in Zipkin it typically is. No default\n#\n# Setup like this:\n# # We use a 30s start period to avoid marking the container unhealthy on slow or contended CI hosts\n# HEALTHCHECK --interval=1s --start-period=30s --timeout=5s CMD [\"docker-healthcheck\"]\n#\n# Note: this is named docker-healthcheck, not docker_healthcheck like our other scripts. That's due\n# to conventions in https://github.com/docker-library/healthcheck/\n\n# Fail on unset variables, but don't quit on rc!=0, so we can log what happened\nset -u +e\n\n# Export healthcheck variables we can read from pid 1. Some processes such as nginx wipe env. In\n# that case, this will still be able to see variables set as ENV instructions in the Dockerfile.\nexport `cat /proc/1/environ| tr '\\0' '\\n'| \\\n egrep '^(HEALTHCHECK_KIND|HEALTHCHECK_IP|HEALTHCHECK_PATH|HEALTHCHECK_PORT)='`\n\nkind=${HEALTHCHECK_KIND:-http}\nip=${HEALTHCHECK_IP:-$(hostname -i || echo '127.0.0.1')}\nport=${HEALTHCHECK_PORT?-is required}\n\ncase ${kind} in\n http )\n path=${HEALTHCHECK_PATH:-/health}\n endpoint=\"http://${ip}:${port}${path}\"\n # Use b3:0 to ensure health checks aren't traced\n # Use timeout 1s (-T 1) as the health check interval is often 1s\n out=$(wget -T 1 -qO- \"${endpoint}\" --header=b3:0 2>&1)\n rc=$?\n ;;\n tcp )\n # Use timeout 1s (-w 1) as the health check interval is often 1s\n out=$(nc -w 1 -z ${ip} ${port} 2>&1)\n rc=$?\n ;;\n * )\n >&2 echo \"Invalid HEALTHCHECK_KIND: ${kind}\"\n exit 1\n ;;\nesac\n\nif [ \"$rc\" = \"0\" ]; then exit 0; fi\n>&2 echo \"Health check failed with code ${rc} response: ${out}\"\nexit 1\n" }, { "path": "build-bin/docker/docker_arch", "content": "#!/bin/sh\n#\n# Copyright The OpenZipkin Authors\n# SPDX-License-Identifier: Apache-2.0\n#\n\n# This script gets a normalized name for the architecture as used in Docker. This will be a subset\n# of ones supported by buildx: https://github.com/docker/buildx/releases. This is a subset because\n# for us to support a platform implies also supporting things like running NPM on it, so it should\n# be an explicit act to add a platform.\n\nset -ue\n\n# Normalize docker_arch to what's available\n#\n# Note: s390x and ppc64le were added for Knative\ndocker_arch=${DOCKER_ARCH:-$(uname -m)}\ncase ${docker_arch} in\n amd64* )\n docker_arch=amd64\n ;;\n x86_64* )\n docker_arch=amd64\n ;;\n arm64* )\n docker_arch=arm64\n ;;\n aarch64* )\n docker_arch=arm64\n ;;\n s390x* )\n docker_arch=s390x\n ;;\n ppc64le* )\n docker_arch=ppc64le\n ;;\n * )\n >&2 echo \"Unsupported DOCKER_ARCH: ${docker_arch}\"\n exit 1;\nesac\n\necho ${docker_arch}\n" }, { "path": "build-bin/docker/docker_args", "content": "#!/bin/sh\n#\n# Copyright The OpenZipkin Authors\n# SPDX-License-Identifier: Apache-2.0\n#\n\n# This builds common docker arguments used by docker_build and docker_push.\n\n# This script checks each variable value, so it isn't important to fail on unbound (set -u)\nset -e\n\ndocker_file=${DOCKER_FILE:-docker/Dockerfile}\nif ! test -f ${docker_file}; then\n >&2 echo \"${docker_file} doesn't exist\"\n exit 1\nfi\n\n# Add default labels for the day and the SHA we're building from\ndocker_args=\"${DOCKER_ARGS:-} -f ${docker_file} \\\n--label org.opencontainers.image.created=$(date +%Y-%m-%d) \\\n--label org.opencontainers.image.revision=$(git rev-parse --short HEAD)\"\n\nversion=${1:-}\nif [ -n \"${version}\" ]; then\n docker_args=\"${docker_args} --build-arg version=${version}\"\nfi\n\n# When true, the artifact searched with `build-bin/maven/unjar` is in the context root\n# Ensure .dockerignore allows the artifacts intended.\nif [ \"${RELEASE_FROM_MAVEN_BUILD}\" = \"true\" ]; then\n docker_args=\"${docker_args} --build-arg release_from_maven_build=true\"\nfi\n\n# When non-empty the target to build.\nif [ -n \"${DOCKER_TARGET}\" ]; then\n docker_args=\"${docker_args} --target ${DOCKER_TARGET}\"\nfi\n\n# When non-empty, becomes the base layer including tag appropriate for the image being built.\n# e.g. ghcr.io/openzipkin/java:21.0.6_p7-jre\n#\n# This is not required to be a base (FROM scratch) image like ghcr.io/openzipkin/alpine:3.12.3\n# See https://docs.docker.com/glossary/#parent-image\nif [ -n \"${DOCKER_PARENT_IMAGE}\" ]; then\n docker_args=\"${docker_args} --build-arg docker_parent_image=${DOCKER_PARENT_IMAGE}\"\nfi\n\n# When non-empty, becomes the build-arg alpine_version. e.g. \"3.12.3\"\n# Used to align base layers from https://github.com/orgs/openzipkin/packages/container/package/alpine\nif [ -n \"${ALPINE_VERSION}\" ]; then\n docker_args=\"${docker_args} --build-arg alpine_version=${ALPINE_VERSION}\"\nfi\n\n# When non-empty, becomes the build-arg java_version. e.g. \"21.0.6_p7\"\n# Used to align base layers from https://github.com/orgs/openzipkin/packages/container/package/java\nif [ -n \"${JAVA_VERSION}\" ]; then\n docker_args=\"${docker_args} --build-arg java_version=${JAVA_VERSION}\"\n\n # Only set java_home build arg when we control or can verify it.\n java_major_version=$(echo ${JAVA_VERSION}| cut -f1 -d .)\n case ${java_major_version} in\n 8) java_home=/usr/lib/jvm/java-1.8-openjdk;;\n 1?|2?|3?) java_home=/usr/lib/jvm/java-${java_major_version}-openjdk;;\n esac\n\n if [ -n \"${java_home}\" ]; then docker_args=\"${docker_args} --build-arg java_home=${java_home}\"; fi\nfi\n\n# When non-empty, becomes the build-arg maven_classifier. e.g. \"module\" or \"exec\"\n# Used as the classifier arg to ./build-bin/maven/maven_unjar. Allows building two images with the\n# same Dockerfile, varying on classifier, like openzipkin/zipkin vs openzipkin/zipkin-slim\nif [ -n \"${MAVEN_CLASSIFIER}\" ]; then\n docker_args=\"${docker_args} --build-arg maven_classifier=${MAVEN_CLASSIFIER}\"\nfi\n\necho ${docker_args}\n" }, { "path": "build-bin/docker/docker_block_on_health", "content": "#!/bin/sh\n#\n# Copyright The OpenZipkin Authors\n# SPDX-License-Identifier: Apache-2.0\n#\n\n# Blocks until a named docker container with a valid HEALTHCHECK instruction is healthy or not:\n\nset -ue\n\ncontainer_name=${1?container_name is required}\ncontainer_id=$(docker ps -q -f name=${container_name})\n\nwhile status=\"$(docker inspect --format=\"{{if .Config.Healthcheck}}{{print .State.Health.Status}}{{end}}\" \"${container_id}\")\"; do\n case $status in\n starting) sleep 1;;\n healthy) exit 0;;\n unhealthy) exit 1;;\n esac\ndone\nexit 1\n" }, { "path": "build-bin/docker/docker_build", "content": "#!/bin/sh\n#\n# Copyright The OpenZipkin Authors\n# SPDX-License-Identifier: Apache-2.0\n#\n\nset -ue\n\ndocker_tag=${1?full docker_tag is required. Ex openzipkin/zipkin:test}\nversion=${2:-}\ndocker_args=$($(dirname \"$0\")/docker_args ${version})\n\n# We don't need build kit, but Docker 20.10 no longer accepts --platform\n# without it. It is simpler to always enable it vs require maintainers to use\n# alternate OCI tools. See https://github.com/moby/moby/issues/41552\nexport DOCKER_BUILDKIT=1\n\necho \"Building image ${docker_tag}\"\ndocker build --network=host --pull ${docker_args} --tag ${docker_tag} .\n" }, { "path": "build-bin/docker/docker_push", "content": "#!/bin/sh\n#\n# Copyright The OpenZipkin Authors\n# SPDX-License-Identifier: Apache-2.0\n#\n\n# This script pushes images to GitHub Container Registry (ghcr.io).\n#\n# When a release, and DOCKER_RELEASE_REPOS is unset they also push to Docker Hub (docker.io).\n#\n# Note: In CI, `configure_docker_push` must be called before invoking this.\n#\n# Avoid buildx on push for reasons including:\n# * Caching is more complex as builder instances must be considered\n# * Platform builds run in parallel, leading to port conflict failures (ex in cassandra)\n# * 0.4.2 multi-platform builds have failed due to picking the wrong image for a FROM instruction\nset -ue\n\ndocker_image=${1?docker_image is required, notably without a tag. Ex openzipkin/zipkin}\nversion=${2:-master}\n\n# We don't need build kit, but Docker 20.10 no longer accepts --platform\n# without it. It is simpler to always enable it vs require maintainers to use\n# alternate OCI tools. See https://github.com/moby/moby/issues/41552\nexport DOCKER_BUILDKIT=1\n\ncase ${version} in\n master )\n is_release=false\n ;;\n *-SNAPSHOT )\n is_release=false\n ;;\n * )\n is_release=true\n ;;\nesac\n\nif [ \"${is_release}\" = \"true\" ]; then\n docker_tags=${DOCKER_TAGS:-}\n if [ -z \"${docker_tags}\" ]; then\n major_tag=$(echo \"${version}\" | cut -f1 -d. -s)\n minor_tag=$(echo \"${version}\" | cut -f1-2 -d. -s)\n subminor_tag=\"${version}\"\n docker_tags=\"$subminor_tag $minor_tag $major_tag latest\"\n fi\n docker_repos=${DOCKER_RELEASE_REPOS:-ghcr.io docker.io}\nelse\n docker_tags=master\n docker_repos=ghcr.io\nfi\n\ntags=\"\"\nfor repo in ${docker_repos}; do\n tags=\"${tags}\\n\"\n for tag in ${docker_tags}; do\n tags=\"${tags} ${repo}/${docker_image}:${tag}\"\n done\ndone\n\ndocker_args=$($(dirname \"$0\")/docker_args ${version})\n# Note: s390x and ppc64le were added for Knative\ndocker_archs=${DOCKER_ARCHS:-amd64 arm64 s390x ppc64le}\n\necho \"Will build the following architectures: ${docker_archs}\"\n\ndocker_tag0=\"$(echo ${docker_tags} | awk '{print $1;}')\"\ndocker_arch0=\"$(echo ${docker_archs} | awk '{print $1;}')\"\narch_tags=\"\"\nfor docker_arch in ${docker_archs}; do\n arch_tag=${docker_image}:${docker_tag0}-${docker_arch}\n echo \"Building tag ${arch_tag}...\"\n docker build --pull ${docker_args} --platform linux/${docker_arch} --tag ${arch_tag} .\n arch_tags=\"${arch_tags} ${arch_tag}\"\ndone\n\necho \"Will push the following tags:\\n${tags}\"\n\nif [ \"${docker_arch0}\" = \"${docker_archs}\" ]; then\n # single architecture\n arch_tag=${docker_image}:${docker_tag0}-${docker_arch0}\n\n for tag in $(echo ${tags} | xargs); do\n docker tag ${arch_tag} ${tag}\n echo \"Pushing tag ${tag}...\"\n docker push ${tag}\n done\n\nelse\n # multi-architecture: make a manifest\n for tag in $(echo ${tags} | xargs); do\n manifest_tags=\"\"\n for arch_tag in ${arch_tags}; do\n docker_arch=$(echo ${arch_tag} | sed 's/.*-//g')\n manifest_tag=${tag}-${docker_arch}\n docker tag ${arch_tag} ${manifest_tag}\n echo \"Pushing tag ${manifest_tag}...\"\n docker push ${manifest_tag}\n manifest_tags=\"${manifest_tags} ${manifest_tag}\"\n done\n\n docker manifest create ${tag} ${manifest_tags}\n\n for manifest_tag in ${manifest_tags}; do\n docker_arch=$(echo ${manifest_tag} | sed 's/.*-//g')\n docker manifest annotate ${tag} ${manifest_tag} --os linux --arch ${docker_arch}\n done\n\n echo \"Pushing manifest ${manifest_tag}...\"\n docker manifest push -p ${tag}\n done\nfi\n" }, { "path": "build-bin/docker/docker_test_image", "content": "#!/bin/sh\n#\n# Copyright The OpenZipkin Authors\n# SPDX-License-Identifier: Apache-2.0\n#\n\n# Tests a an image by awaiting its HEALTHCHECK.\n#\n# This can be made more sophisticated via docker-compose. For example, you can set a utility\n# container that issues `wget` against your actual container in its HEALTHCHECK.\n\nset -ue\n\n# export this variable so that docker compose can use it\nexport DOCKER_IMAGE=${1?full docker_tag is required. Ex openzipkin/zipkin:test}\n# The two options are to run a single container of the image, or docker compose which includes it.\ndocker_compose_file=${2:-build-bin/docker-compose-$(echo ${DOCKER_IMAGE}| sed 's~.*/\\(.*\\):.*~\\1~g').yml}\ndocker_container=${3:-sut}\n\n# First try to run the intended containers.\nhealth_rc=0\nif test -f \"${docker_compose_file}\"; then\n docker compose -f \"${docker_compose_file}\" up --remove-orphans -d --quiet-pull || health_rc=1\nelse\n docker run --name ${docker_container} -d ${DOCKER_IMAGE} || health_rc=1\nfi\n\n# Next, inspect the health. This is a blocking command which waits until HEALTHCHECK passes or not.\n# This will fail if the container isn't healthy or doesn't exist (ex compose failed before creation)\nif [ \"${health_rc}\" = \"1\" ] || ! build-bin/docker/docker_block_on_health ${docker_container}; then\n >&2 echo \"*** Failed waiting for health of ${docker_container}\"\n\n # Sadly, we can't `docker compose inspect`. This means we may not see the inspect output of the\n # container that failed in docker compose until this is revised to work around compose/issues/4155\n docker inspect --format='{{json .State.Health.Log}}' ${docker_container} || true\n\n # Log any containers output to console before we remove them.\n if test -f \"${docker_compose_file}\"; then\n docker compose -f \"${docker_compose_file}\" logs\n else\n docker logs ${docker_container} || true\n fi\n health_rc=1\nfi\n\n# Clean up any containers, so that we can run this again without conflict.\nif test -f \"${docker_compose_file}\"; then\n docker compose -f \"${docker_compose_file}\" down\nelse\n docker kill ${docker_container} && docker rm ${docker_container}\nfi\n\nexit ${health_rc}\n\n" }, { "path": "build-bin/docker-compose-zipkin-eureka.yml", "content": "#\n# Copyright The OpenZipkin Authors\n# SPDX-License-Identifier: Apache-2.0\n#\n\n# uses 2.4 so we can use condition: service_healthy\nversion: \"2.4\"\n\n# Test both authenticated and unauthenticated, as if there is a Spring problem,\n# the latter will crash. We only need to use HEALTHCHECK for this.\nservices:\n eureka:\n image: openzipkin/zipkin-eureka:test\n container_name: eureka\n sut:\n image: openzipkin/zipkin-eureka:test\n container_name: sut\n environment:\n EUREKA_USERNAME: testuser\n EUREKA_PASSWORD: testpassword\n depends_on:\n eureka:\n condition: service_healthy\n" }, { "path": "build-bin/docker-compose-zipkin-ui.yml", "content": "#\n# Copyright The OpenZipkin Authors\n# SPDX-License-Identifier: Apache-2.0\n#\n\n# uses 2.4 so we can use condition: service_healthy\nversion: \"2.4\"\n\nservices:\n zipkin:\n # Use last build of Zipkin instead of adding a matrix build dependency\n image: ghcr.io/openzipkin/zipkin-slim:master\n container_name: zipkin\n # Use fixed service and container name 'sut; so our test script can copy/pasta\n sut:\n # This is the image just built. It is not in a remote repository.\n image: openzipkin/zipkin-ui:test\n container_name: sut\n environment:\n # This is the default value, set explicitly here for visibility\n ZIPKIN_BASE_URL: http://zipkin:9411\n depends_on:\n zipkin:\n condition: service_healthy\n" }, { "path": "build-bin/docker-compose-zipkin-uiproxy.yml", "content": "#\n# Copyright The OpenZipkin Authors\n# SPDX-License-Identifier: Apache-2.0\n#\n\n# uses 2.4 so we can use condition: service_healthy\nversion: \"2.4\"\n\nservices:\n zipkin:\n # Use last build of Zipkin instead of adding a matrix build dependency\n image: ghcr.io/openzipkin/zipkin-slim:master\n container_name: zipkin\n environment:\n ZIPKIN_UI_BASEPATH: /admin/zipkin\n # Use fixed service and container name 'sut; so our test script can copy/pasta\n sut:\n # This is the image just built. It is not in a remote repository.\n image: openzipkin/zipkin-ui:test\n container_name: sut\n environment:\n ZIPKIN_UI_BASEPATH: /admin/zipkin\n depends_on:\n zipkin:\n condition: service_healthy\n" }, { "path": "build-bin/docker-compose-zipkin.yml", "content": "#\n# Copyright The OpenZipkin Authors\n# SPDX-License-Identifier: Apache-2.0\n#\n\n# uses 2.4 so we can use condition: service_healthy\nversion: \"2.4\"\n\nservices:\n zipkin:\n # Use last build of Zipkin instead of adding a matrix build dependency\n image: openzipkin/zipkin:test\n container_name: zipkin\n # Use fixed service and container name 'sut; so our test script can copy/pasta\n sut:\n container_name: sut\n image: ghcr.io/openzipkin/alpine:3.21.2\n entrypoint: /bin/sh\n # Keep the container running until HEALTHCHECK passes\n command: \"-c \\\"sleep 5m\\\"\"\n healthcheck:\n # Return 0 when we can load the UI resources\n test: wget -qO- --spider http://zipkin:9411/zipkin/\n depends_on:\n zipkin:\n condition: service_healthy\n" }, { "path": "build-bin/docker_push", "content": "#!/bin/sh -ue\n#\n# Copyright The OpenZipkin Authors\n# SPDX-License-Identifier: Apache-2.0\n#\n\n\n# Pushes docker as part of `deploy` or from a trigger tag\nversion=${1:-master}\n\n# handle trigger pattern like /^docker-[0-9]+\\.[0-9]+\\.[0-9]+$/\ncase ${version} in\n docker-* )\n version=$(build-bin/git/version_from_trigger_tag docker- ${version})\n ;;\nesac\n\nbuild-bin/docker/docker_push openzipkin/zipkin ${version}\nDOCKER_TARGET=zipkin-slim build-bin/docker/docker_push openzipkin/zipkin-slim ${version}\n\n# testing images only push to ghcro.io\nexport DOCKER_RELEASE_REPOS=ghcr.io\n# Don't attempt unfamiliar archs on test images\nexport DOCKER_ARCHS=\"amd64 arm64\"\n\nfor name in $(ls docker/test-images/*/Dockerfile|cut -f3 -d/); do\n DOCKER_FILE=docker/test-images/${name}/Dockerfile build-bin/docker/docker_push openzipkin/${name} ${version}\ndone\n" }, { "path": "build-bin/git/login_git", "content": "#!/bin/sh\n#\n# Copyright The OpenZipkin Authors\n# SPDX-License-Identifier: Apache-2.0\n#\n\nset -ue\n\n# Allocate commits to CI, not the owner of the deploy key\ngit config user.name \"zipkinci\"\ngit config user.email \"zipkinci+zipkin-dev@googlegroups.com\"\n\n# Setup https authentication credentials, used by ./mvnw release:prepare\ngit config credential.helper \"store --file=.git/credentials\"\necho \"https://$GH_TOKEN:@github.com\" > .git/credentials\n" }, { "path": "build-bin/git/version_from_trigger_tag", "content": "#!/bin/sh\n#\n# Copyright The OpenZipkin Authors\n# SPDX-License-Identifier: Apache-2.0\n#\n\n# This script echos a `MAJOR.MINOR.PATCH` version tag based on..\n# * arg1: XXXXX- prefix\n# * arg2: XXXXX-MAJOR.MINOR.PATCH git trigger tag\n#\n# The script exits 1 if the prefix doesn't match. On success, the tag is deleted if it exists.\n#\n# Note: In CI, `build-bin/git/login_git` must be called before invoking this.\n\nset -ue\n\ntrigger_tag_prefix=${1?required. Ex docker- to match docker-1.2.3}\ntrigger_tag=${2?trigger_tag is required. Ex ${trigger_tag_prefix}1.2.3}\n\n# Checking sed output to determine success as exit code handling in sed or awk is awkward\nversion=$(echo \"${trigger_tag}\" | sed -En \"s/^${trigger_tag_prefix}([0-9]+\\.[0-9]+\\.[0-9]+)$/\\1/p\")\n\nif [ -z \"$version\" ]; then\n >&2 echo invalid trigger tag: ${trigger_tag}\n exit 1;\nfi\n\n# try to cleanup the trigger tag if it exists, but don't fail if it doesn't\ngit tag -d ${trigger_tag} 2>&- >&- || true\ngit push origin :${trigger_tag} 2>&- >&- || true\n\necho $version\n" }, { "path": "build-bin/gpg/configure_gpg", "content": "#!/bin/sh\n#\n# Copyright The OpenZipkin Authors\n# SPDX-License-Identifier: Apache-2.0\n#\n\n# This script prepares GPG, needed to sign jars for Sonatype deployment during `maven_deploy`\n\nset -ue\n\n# ensure GPG commands work non-interactively\nexport GPG_TTY=$(tty)\n# import signing key used for jar files\necho ${GPG_SIGNING_KEY} | base64 --decode | gpg --batch --passphrase ${GPG_PASSPHRASE} --import\n" }, { "path": "build-bin/javadoc_to_gh_pages", "content": "#!/bin/sh -ue\n#\n# Copyright The OpenZipkin Authors\n# SPDX-License-Identifier: Apache-2.0\n#\n\n# This script creates JavaDoc for a version and pushes an update to gh-pages. This fails if there\n# are no javadoc jars in the current directory.\n#\n# This leaves the git context on gh-pages when done. For this reason, it is better to run this at\n# the end of deployment.\nversion=${1?version is required. Ex 2.22.2}\n\nrm -rf javadoc-builddir\nbuilddir=\"javadoc-builddir/${version}\"\n\njavadoc_jars=$(find . -name \"*${version}-javadoc.jar\")\nif [ -z \"${javadoc_jars}\"]; then\n >&2 echo Incorrect state. javadoc jars should have been built before invoking this.\n exit 1\nfi\n\n# Collect javadoc for all modules\nfor jar in ${javadoc_jars}; do\n module=\"$(echo \"$jar\" | sed \"s~.*/\\(.*\\)-${version}-javadoc.jar~\\1~\")\"\n this_builddir=\"$builddir/$module\"\n if [ -d \"$this_builddir\" ]; then\n # Skip modules we've already processed.\n # We may find multiple instances of the same javadoc jar because of, for instance,\n # integration tests copying jars around.\n continue\n fi\n mkdir -p \"$this_builddir\"\n unzip \"$jar\" -d \"$this_builddir\"\n # Build a simple module-level index\n echo \"

  • ${module}
    • \" >> \"${builddir}/index.html\"\ndone\n\n# Update gh-pages\ngit fetch origin gh-pages:gh-pages\ngit checkout gh-pages\nrm -rf \"${version}\"\nmv \"javadoc-builddir/${version}\" ./\nrm -rf \"javadoc-builddir\"\n\n# Update simple version-level index\nif ! grep \"${version}\" index.html 2>/dev/null; then\n echo \"
  • ${version}
    • \" >> index.html\nfi\n\n# Ensure links are ordered by versions, latest on top\nsort -rV index.html > index.html.sorted\nmv index.html.sorted index.html\n\ngit add \"${version}\"\ngit add index.html\ngit commit -m \"Automatically updated javadocs for ${version}\"\ngit push origin gh-pages\n" }, { "path": "build-bin/lint", "content": "#!/bin/sh -ue\n\nyamllint --format github .github/workflows/*.yml\nfind . -name \\*.md |grep -v node|xargs markdown-link-check -c ./build-bin/mlc_config.json\n" }, { "path": "build-bin/maven/maven_build", "content": "#!/bin/sh\n#\n# Copyright The OpenZipkin Authors\n# SPDX-License-Identifier: Apache-2.0\n#\n\nset -ue\n\nexport MAVEN_OPTS=\"$($(dirname \"$0\")/maven_opts)\"\nmaven_goal=${MAVEN_GOAL:-package}\nif [ -x ./mvnw ]; then alias mvn=${PWD}/mvnw; fi\n\n(\n if [ \"${MAVEN_PROJECT_BASEDIR:-.}\" != \".\" ]; then cd ${MAVEN_PROJECT_BASEDIR}; fi\n mvn -T1C -q --batch-mode -DskipTests \"${maven_goal}\" \"$@\"\n)\n" }, { "path": "build-bin/maven/maven_build_or_unjar", "content": "#!/bin/sh\n#\n# Copyright The OpenZipkin Authors\n# SPDX-License-Identifier: Apache-2.0\n#\n\nset -ue\n\n# Like `maven_unjar`, except when the version ends in SNAPSHOT and the artifact isn't in the $PWD,\n# it is built on-demand using `mvn package`. MAVEN_PROJECT_BASEDIR is used when the version arg or\n# artifact is missing.\n#\n# Note: Be careful building on-demand within Docker, as it can cause high bandwidth usage, pulling\n# dependencies for the project without the benefit of caching\n\ngroup_id=${1?group_id is required}\nartifact_id=${2?artifact_id is required}\nversion=${3?version is required}\nclassifier=${4:-}\n\npom=\"${MAVEN_PROJECT_BASEDIR:-.}/pom.xml\"\n\n# Use implicit version when master, if we can..\nif [ \"${version}\" = \"master\" ] && [ -f \"${pom}\" ]; then\n version=$(sed -En 's/.*(.*)<\\/version>.*/\\1/p' ${pom}| head -1)\nfi\n\n# rebuild the args with the version set.\nargs=\"${group_id} ${artifact_id} ${version} ${classifier}\"\n\n# Fail on unset variables, but don't quit on rc!=0, so we can log what happened\nset -u +e\n\nunjar_out=$($(dirname \"$0\")/maven_unjar $args 2>&1)\nunjar_rc=$?\n\nif [ \"${unjar_rc}\" = \"0\" ] || [ -z \"${pom:-}\" ]; then\n exit 0;\nfi\n\ncase ${version} in\n *-SNAPSHOT )\n ;;\n * )\n >&2 echo ${unjar_out}\n exit ${unjar_rc}\n ;;\nesac\n\nset -ue\n\necho \"*** Building snapshot from source...\"\n$(dirname \"$0\")/maven_build -pl :${artifact_id} --am\n$(dirname \"$0\")/maven_unjar $args\n" }, { "path": "build-bin/maven/maven_deploy", "content": "#!/bin/sh\n#\n# Copyright The OpenZipkin Authors\n# SPDX-License-Identifier: Apache-2.0\n#\n\nset -ue\n\nexport MAVEN_OPTS=\"$($(dirname \"$0\")/maven_opts)\"\n\n# This script deploys a SNAPSHOT or release version to Sonatype.\n#\n# Note: In CI, `configure_maven_deploy` must be called before invoking this.\n./mvnw --batch-mode -s ./.settings.xml -Prelease -nsu -DskipTests clean deploy $@\n" }, { "path": "build-bin/maven/maven_go_offline", "content": "#!/bin/sh\n#\n# Copyright The OpenZipkin Authors\n# SPDX-License-Identifier: Apache-2.0\n#\n\n# This is a go-offline that properly works with multi-module builds\n\nset -ue\n\nexport MAVEN_OPTS=\"$($(dirname \"$0\")/maven_opts)\"\nif [ -x ./mvnw ]; then alias mvn=${PWD}/mvnw; fi\n\n(\n if [ \"${MAVEN_PROJECT_BASEDIR:-.}\" != \".\" ]; then cd ${MAVEN_PROJECT_BASEDIR}; fi\n mvn -q --batch-mode -nsu -Prelease de.qaware.maven:go-offline-maven-plugin:resolve-dependencies \"$@\"\n)\n" }, { "path": "build-bin/maven/maven_opts", "content": "#!/bin/sh\n#\n# Copyright The OpenZipkin Authors\n# SPDX-License-Identifier: Apache-2.0\n#\n\n# This script checks each variable value, so it isn't important to fail on unbound (set -u)\nset -e\n\nmaven_project_basedir=${MAVEN_PROJECT_BASEDIR:-.}\npom=\"${maven_project_basedir}/pom.xml\"\n\n# fail if there's no pom\ntest -f \"${pom}\"\n\narch=$(uname -m)\ncase ${arch} in\n arm64* )\n arch=arm64\n ;;\n aarch64* )\n arch=arm64\n ;;\nesac\n\nmaven_opts=\"${MAVEN_OPTS:-}\"\nif [ ${arch} = \"arm64\" ] && [ -f /etc/alpine-release ]; then\n # Defensively avoid arm64+alpine problems with posix_spawn\n maven_opts=\"${maven_opts} -Djdk.lang.Process.launchMechanism=vfork\"\nfi\n\necho ${maven_opts}\n" }, { "path": "build-bin/maven/maven_release", "content": "#!/bin/sh\n#\n# Copyright The OpenZipkin Authors\n# SPDX-License-Identifier: Apache-2.0\n#\n\nset -ue\n\n# This script creates a git `MAJOR.MINOR.PATCH` version tag which later will have `deploy` run against it.\n#\n# In CI..\n# * trigger pattern: tag =~ /^release-[0-9]+\\.[0-9]+\\.[0-9]+/\n# * build-bin/git/login_git must be called before invoking this.\n\nexport MAVEN_OPTS=\"$($(dirname \"$0\")/maven_opts)\"\n\ntrigger_tag=${1?trigger_tag is required. Ex release-1.2.3}\nrelease_version=$(build-bin/git/version_from_trigger_tag release- ${trigger_tag})\nrelease_branch=${2:-master}\n\n# Checkout master, as we release from master, not a tag ref\ngit fetch --no-tags --prune --depth=1 origin +refs/heads/${release_branch}:refs/remotes/origin/${release_branch}\ngit checkout ${release_branch}\n\n# Ensure no one pushed commits since this release tag as it would fail later commands\ncommit_local_release_branch=$(git show --pretty='format:%H' ${release_branch})\ncommit_remote_release_branch=$(git show --pretty='format:%H' origin/${release_branch})\nif [ \"$commit_local_release_branch\" != \"$commit_remote_release_branch\" ]; then\n >&2 echo \"${release_branch} on remote 'origin' has commits since the version to release, aborting\"\n exit 1\nfi\n\n# Prepare and push release commits and the version tag (N.N.N), which triggers deployment.\n./mvnw --batch-mode -nsu -DreleaseVersion=${release_version} -Denforcer.fail=false -Darguments=\"-DskipTests -Denforcer.fail=false\" release:prepare\n" }, { "path": "build-bin/maven/maven_unjar", "content": "#!/bin/sh\n#\n# Copyright The OpenZipkin Authors\n# SPDX-License-Identifier: Apache-2.0\n#\n\n# This script gets one jar from Maven, most typically an exec or module jar, extracting its contents\n# to a directory corresponding to the artifact_id parameter.\n#\n# Ex. ./maven_unjar io.zipkin zipkin-server 2.22.2 slim\n#\n# This searches ${MAVEN_PROJECT_BASEDIR} when set instead of resolving remotely.\n#\n# Note: If you are running this within Docker, ensure you have .dockerignore setup properly to pass\n# the artifact you are looking for.\n#\n# Ex.\n# !./module/target/zipkin-module-*-module.jar\n\nset -eu\n\nexport MAVEN_OPTS=\"$($(dirname \"$0\")/maven_opts)\"\nif [ -x ./mvnw ]; then alias mvn=${PWD}/mvnw; fi\n\ngroup_id=${1?group_id is required}\nartifact_id=${2?artifact_id is required}\nversion=${3?version is required}\nclassifier=${4:-}\n\nif [ -n \"${classifier}\" ]; then\n qualified_jar=${artifact_id}-${version}-${classifier}.jar\nelse\n qualified_jar=${artifact_id}-${version}.jar\nfi\n\ncase ${version} in\n *-SNAPSHOT )\n is_release=false\n ;;\n * )\n is_release=true\n ;;\nesac\n\n# Parse MAVEN_OPTS as it may have overridden .m2/repository\nlocal_repo=$(echo ${MAVEN_OPTS} | sed -n 's/.*maven.repo.local=\\([^ ]*\\).*/\\1/p')\nif [ \"${local_repo}\" = \"\" ]; then local_repo=$HOME/.m2/repository; fi\n\nlocal_repo_path=${local_repo}/$(echo ${group_id} | tr '.' '/')/${artifact_id}/${version}/${qualified_jar}\n\nif test -f ${local_repo_path}; then\n echo \"*** Reusing ${qualified_jar} from Maven local repository...\"\n cp ${local_repo_path} ${artifact_id}.jar\nelif [ -n \"${MAVEN_PROJECT_BASEDIR:-}\" ]; then\n echo \"*** Searching for ${qualified_jar} in ${MAVEN_PROJECT_BASEDIR}\"\n find ${MAVEN_PROJECT_BASEDIR} -name ${qualified_jar} -exec cp {} ${artifact_id}.jar \\;\nfi\n\nif ! test -f ${artifact_id}.jar && [ ${is_release} = \"true\" ]; then\n mvn_get=\"mvn -q --batch-mode -Denforcer.fail=false \\\n org.apache.maven.plugins:maven-dependency-plugin:3.8.1:get \\\n -Dtransitive=false -DgroupId=${group_id} -DartifactId=${artifact_id} -Dversion=${version}\"\n\n if [ -n \"${classifier}\" ]; then\n mvn_get=\"${mvn_get} -Dclassifier=${classifier}\"\n fi\n\n echo \"*** Resolving ${qualified_jar} from Maven default repositories...\"\n ${mvn_get} || true\n\n # Don't add load to Sonatype releases repository except when central sync is delayed\n if ! test -f ${local_repo_path}; then\n echo \"*** Resolving ${qualified_jar} from Maven Sonatype releases repository...\"\n ${mvn_get} -DremoteRepositories=https://oss.sonatype.org/content/repositories/releases\n fi\n\n cp ${local_repo_path} ${artifact_id}.jar\nfi\n\nif ! test -f ${artifact_id}.jar; then\n >&2 echo \"*** Failed to build or get ${qualified_jar}\"\n exit 1\nfi\n\n(mkdir ${artifact_id} && cd ${artifact_id} && jar -xf ../${artifact_id}.jar) && rm ${artifact_id}.jar\n" }, { "path": "build-bin/maven_go_offline", "content": "#!/bin/sh -ue\n#\n# Copyright The OpenZipkin Authors\n# SPDX-License-Identifier: Apache-2.0\n#\n\n\nbuild-bin/maven/maven_go_offline\nexport MAVEN_OPTS=\"$(build-bin/maven/maven_opts)\"\n# Prefetch dependencies used by zipkin-ui (NPM and NodeJS binary and dependencies of our build)\n./mvnw -q --batch-mode -nsu -pl zipkin-lens generate-resources\n" }, { "path": "build-bin/maybe_install_npm", "content": "#!/bin/sh -ue\n#\n# Copyright The OpenZipkin Authors\n# SPDX-License-Identifier: Apache-2.0\n#\n\n# This script hydrates the Maven and NPM cache to make later processes operate with less chance of\n# network problems.\narch=$(uname -m)\ncase ${arch} in\n arm64* )\n arch=arm64\n ;;\n aarch64* )\n arch=arm64\n ;;\nesac\n\n# ARM64 is not supported with musl, yet https://github.com/nodejs/node/blob/master/BUILDING.md\n# Workaround this by installing node and npm directly. See issue #3166\nif [ ${arch} = \"arm64\" ] && [ -f /etc/alpine-release ]; then\n\n export MAVEN_OPTS=\"$($(dirname \"$0\")/maven/maven_opts)\"\n if [ -x ./mvnw ]; then alias mvn=${PWD}/mvnw; fi\n if [ \"${MAVEN_PROJECT_BASEDIR:-.}\" != \".\" ]; then cd ${MAVEN_PROJECT_BASEDIR}; fi\n\n # Get the version of nodejs the build uses. Note: this takes time as it downloads Maven plugins.\n node_version=$(mvn help:evaluate -Dexpression=node.version -DskipTests -q -DforceStdout -pl zipkin-lens)\n\n set -x\n # Repos for https://pkgs.alpinelinux.org/packages?name=nodejs are already in the base image.\n apk add --update --no-cache nodejs=~${node_version} npm\nfi\n" }, { "path": "build-bin/mlc_config.json", "content": "{\n \"ignorePatterns\": [\n {\n \"pattern\": \"https://chromewebstore.google.com/detail/*\"\n },\n {\n \"pattern\": \"https://stackoverflow.com/questions/tagged/spring-boot\"\n },\n {\n \"pattern\": \"https://oss.sonatype.org/content/repositories/snapshots\"\n },\n {\n \"pattern\": \"http://localhost:9411/api/v[12]/spans\"\n },\n {\n \"pattern\": \"http://localhost:9411/zipkin\"\n },\n {\n \"pattern\": \"http://localhost/admin/zipkin/\"\n },\n {\n \"pattern\": \"http://zipkin:9411\"\n },\n {\n \"pattern\": \"http://localhost:9411/zipkin?serviceName=backend\"\n },\n {\n \"pattern\": \"http://localhost:8081\"\n },\n {\n \"pattern\": \"http://localhost:9000/api\"\n },\n {\n \"pattern\": \"http://localhost:3000\"\n }\n ]\n}\n" }, { "path": "build-bin/test", "content": "#!/bin/sh -ue\n\n# This script runs the tests of the project.\n#\n# See [README.md] for an explanation of this and how CI should use it.\n\n# -DskipActuator ensures no tests rely on the actuator library\n./mvnw -T1C verify -nsu -DskipActuator \"$@\"\n" }, { "path": "docker/Dockerfile", "content": "#\n# Copyright The OpenZipkin Authors\n# SPDX-License-Identifier: Apache-2.0\n#\n\n# java_version is used for install and runtime base layers of zipkin and zipkin-slim.\n#\n# Use latest version here: https://github.com/orgs/openzipkin/packages/container/package/java\n# This is defined in many places because Docker has no \"env\" script functionality unless you use\n# docker-compose: When updating, update everywhere.\nARG java_version=21.0.7_p6\n\n# We copy files from the context into a scratch container first to avoid a problem where docker and\n# docker compose don't share layer hashes https://github.com/docker/compose/issues/883 normally.\n# COPY --from= works around the issue.\nFROM scratch as scratch\n\nCOPY build-bin/docker/docker-healthcheck /docker-bin/\nCOPY docker/start-zipkin /docker-bin/\nCOPY . /code/\n\n# This version is only used during the install process. Try to be consistent as it reduces layers,\n# which reduces downloads.\nFROM ghcr.io/openzipkin/java:${java_version} as install\n\nWORKDIR /code\n# Conditions aren't supported in Dockerfile instructions, so we copy source even if it isn't used.\nCOPY --from=scratch /code/ .\n\nWORKDIR /install\n\n# When true, build-bin/maven/unjar searches /code for the artifact instead of resolving remotely.\n# /code contains what is allowed in .dockerignore. On problem, ensure .dockerignore is correct.\nARG release_from_maven_build=false\nENV RELEASE_FROM_MAVEN_BUILD=$release_from_maven_build\n# Version of the artifact to unjar. Ex. \"2.4.5\" or \"2.4.5-SNAPSHOT\" \"master\" to use the pom version.\nARG version=master\nENV VERSION=$version\nENV MAVEN_PROJECT_BASEDIR=/code\nARG TARGETARCH\nRUN test \"${TARGETARCH}\" != \"\" && \\\n if [ \"${RELEASE_FROM_MAVEN_BUILD}\" == \"false\" ]; then /code/build-bin/maybe_install_npm; fi; \\\n /code/build-bin/maven/maven_build_or_unjar io.zipkin zipkin-server ${VERSION} exec && \\\n mv zipkin-server zipkin && \\\n /code/build-bin/maven/maven_build_or_unjar io.zipkin zipkin-server ${VERSION} slim && \\\n mv zipkin-server zipkin-slim && \\\n # Copy tcnative deps to slim: 1.1MB more libs when pared to current platform.\n cp zipkin/BOOT-INF/lib/*tcnative*.jar zipkin-slim/BOOT-INF/lib/ && \\\n # Remove any unused platform-specific jars. This results in none for s390x or non-linux.\n rm */BOOT-INF/lib/*windows* */BOOT-INF/lib/*osx* && \\\n if [ \"${TARGETARCH}\" != \"amd64\" ]; then rm */BOOT-INF/lib/*x86*; fi && \\\n if [ \"${TARGETARCH}\" != \"arm64\" ]; then rm */BOOT-INF/lib/*a64* */BOOT-INF/lib/*aarch*; fi\n\n# Almost everything is common between the slim and normal build\nFROM ghcr.io/openzipkin/java:${java_version}-jre as base-server\n\n# All content including binaries and logs write under WORKDIR\nARG USER=zipkin\nWORKDIR /${USER}\n\n# Ensure the process doesn't run as root\nRUN adduser -g '' -h ${PWD} -D ${USER}\n\n# Add HEALTHCHECK and ENTRYPOINT scripts into the default search path\nCOPY --from=scratch /docker-bin/* /usr/local/bin/\n# We use start period of 30s to avoid marking the container unhealthy on slow or contended CI hosts.\n#\n# If in production, you have a 30s startup, please report to https://gitter.im/openzipkin/zipkin\n# including the values of the /health and /info endpoints as this would be unexpected.\nHEALTHCHECK --interval=5s --start-period=30s --timeout=5s CMD [\"docker-healthcheck\"]\n\nENTRYPOINT [\"start-zipkin\"]\n\n# Switch to the runtime user\nUSER ${USER}\n\nFROM base-server as zipkin-slim\nLABEL org.opencontainers.image.description=\"Zipkin slim distribution on OpenJDK and Alpine Linux\"\n\nCOPY --from=install --chown=${USER} /install/zipkin-slim/ /zipkin/\n\nEXPOSE 9411\n\nFROM base-server as zipkin\nLABEL org.opencontainers.image.description=\"Zipkin full distribution on OpenJDK and Alpine Linux\"\n\n# 3rd party modules like zipkin-aws will apply profile settings with this\nENV MODULE_OPTS=\n\nCOPY --from=install --chown=${USER} /install/zipkin/ /zipkin/\n\n# Zipkin's full distribution includes Scribe support (albeit disabled)\nEXPOSE 9410 9411\n" }, { "path": "docker/RATIONALE.md", "content": "# zipkin-docker rationale\n\n## Why do we add HEALTHCHECK?\nWhile most of our images are not production, we still add HEALTHCHECK for a better ad-hoc\nand automation experience. Many of our setups will not operate without a service\ndependency: having HEALTHCHECK present makes triage and scripting a bit easier.\n\nHEALTHCHECK on our test image serves primarily three purposes:\n * ad-hoc or scripted status of health using docker ps instead of knowing Kafka commands\n * to allow manual usage of the docker compose v2 service_healthy condition\n * support Docker Hub automated test service\n\nEx. The following command can be used ad-hoc or in scripts without the user knowing Kafka:\n```bash\n$ docker inspect --format='{{json .State.Health.Status}}' kafka-zookeeper\n\"unhealthy\"\n```\n\n### Why do we change default timeouts?\nWe changed timeouts in order to mark success faster.\n\nBy default, the Docker health check runs after 30s, and if a failure occurs,\nit waits 30s to try again. This implies a minimum of 30s before the server is\nmarked healthy.\n\nhttps://docs.docker.com/engine/reference/builder/#healthcheck\n\nWe expect the server startup to take less than 10 seconds, even in a fresh\nstart. Some health checks will trigger a slow \"first request\" due to schema\nsetup (ex this is the case in Elasticsearch and Cassandra). However, we don't\nwant to force an initial delay of 30s as defaults would.\n\nInstead, we lower the interval and timeout from 30s to 5s. If a server starts\nin 7s and takes another 2s to install schema, it can still pass in 10s vs 30s.\n\nWe retain the 30s even if it would be an excessively long startup. This is to\naccommodate test containers, which can boot slower than production sites, and\nany knock-on effects of that, like slow dependent storage containers which are\nsimultaneously bootstrapping.\n\n### Why default timeout to 5s for Kafka HEALTHCHECK?\n\nDocker `HEALTHCHECK` marks a container unhealthy on the first failure that occurs past its start\nperiod. It is important to avoid false negatives that are host contention in nature, as they can\nbreak orchestration such as docker-compose.\n\nCommands like `nc` will almost never timeout launching due to contention, even if they might timeout\non network connections themselves for the same reason.\n\n`kafka-topics.sh` uses Java and a relatively large classpath. It can be slow when many other\nprocesses are starting at the same time. For example, when launching many containers in Docker\nCompose, `kafka-topics.sh` timed out after 2s even though the prior run succeeded. This broke a condition\nwhich broke the rest of the automation. A 5s timeout is excessive usually, but avoided this problem.\n" }, { "path": "docker/README.md", "content": "## zipkin Docker images\nThis directory contains assets used to build and release Zipkin's Docker images.\n\n## Production images\nThe only Zipkin production images built here:\n* openzipkin/zipkin: The core server image that hosts the Zipkin UI, Api and Collector features.\n * Mirrored as ghcr.io/openzipkin/zipkin\n* openzipkin/zipkin-slim: The stripped server image that hosts the Zipkin UI and Api features, but only supports in-memory or Elasticsearch storage with HTTP or gRPC span collectors.\n * Mirrored as ghcr.io/openzipkin/zipkin-slim\n\n## Testing images\n\nWe also provide a number images that are not for production, rather to simplify demos and\nintegration tests. We designed these to be small and start easily. We did this by re-using the same\nbase layer `openzipkin/zipkin`, and setting up schema where relevant.\n\n* [ghcr.io/openzipkin/zipkin-activemq](test-images/zipkin-activemq/README.md) - runs ActiveMQ Classic\n* [ghcr.io/openzipkin/zipkin-cassandra](test-images/zipkin-cassandra/README.md) - runs Cassandra initialized with Zipkin's schema\n* [ghcr.io/openzipkin/zipkin-elasticsearch7](test-images/zipkin-elasticsearch7/README.md) - runs Elasticsearch 7.x\n* [ghcr.io/openzipkin/zipkin-elasticsearch8](test-images/zipkin-elasticsearch8/README.md) - runs Elasticsearch 8.x\n* [ghcr.io/openzipkin/zipkin-opensearch2](test-images/zipkin-opensearch2/README.md) - runs OpenSearch 2.x\n* [ghcr.io/openzipkin/zipkin-eureka](test-images/zipkin-eureka/README.md) - runs Eureka\n* [ghcr.io/openzipkin/zipkin-kafka](test-images/zipkin-kafka/README.md) - runs both Kafka+ZooKeeper\n* [ghcr.io/openzipkin/zipkin-mysql](test-images/zipkin-mysql/README.md) - runs MySQL initialized with Zipkin's schema\n* [ghcr.io/openzipkin/zipkin-pulsar](test-images/zipkin-pulsar/README.md) - runs Pulsar\n* [ghcr.io/openzipkin/zipkin-rabbitmq](test-images/zipkin-rabbitmq/README.md) - runs RabbitMQ\n* [ghcr.io/openzipkin/zipkin-ui](test-images/zipkin-ui/README.md) - serves the (Lens) UI directly with NGINX\n\n## Getting started\n\nZipkin has no dependencies, for example you can run an in-memory zipkin server like so:\n\n```bash\n# Note: this is mirrored as ghcr.io/openzipkin/zipkin-slim\n$ docker run -d -p 9411:9411 openzipkin/zipkin-slim\n```\n\nSee the ui at (docker ip):9411\n\nIn the UI - click zipkin-server, then click \"Find Traces\".\n\nWe also provide [example compose files](examples/README.md) that integrate collectors and storage,\nsuch as Kafka or Elasticsearch.\n\n## Configuration\nConfiguration is via environment variables, defined by [zipkin-server](../zipkin-server/README.md). Notably, you'll want to look at the `STORAGE_TYPE` environment variables, which\ninclude \"cassandra\", \"mysql\" and \"elasticsearch\".\n\nNote: the `openzipkin/zipkin-slim` image only supports \"elasticsearch\" storage. To use other storage types, you must use the main image `openzipkin/zipkin`.\n\nWhen in Docker, the following environment variables also apply\n\n* `JAVA_OPTS`: Use to set java arguments, such as heap size or trust store location.\n * By default, `openzipkin/zipkin` sets max heap to 64m while `openzipkin/zipkin-slim` 32m\n* `STORAGE_PORT_9042_TCP_ADDR` -- A Cassandra node listening on port 9042. This\n environment variable is typically set by linking a container running\n `zipkin-cassandra` as \"storage\" when you start the container.\n* `STORAGE_PORT_3306_TCP_ADDR` -- A MySQL node listening on port 3306. This\n environment variable is typically set by linking a container running\n `zipkin-mysql` as \"storage\" when you start the container.\n* `STORAGE_PORT_9200_TCP_ADDR` -- An Elasticsearch node listening on port 9200. This\n environment variable is typically set by linking a container running\n `zipkin-elasticsearch` as \"storage\" when you start the container. This is ignored\n when `ES_HOSTS` or `ES_AWS_DOMAIN` are set.\n* `KAFKA_PORT_2181_TCP_ADDR` -- A zookeeper node listening on port 2181. This\n environment variable is typically set by linking a container running\n `zipkin-kafka` as \"kafka\" when you start the container.\n\nFor example, to increase heap size, set `JAVA_OPTS` as shown in our [docker-compose](examples/docker-compose.yml) file:\n```yaml\n environment:\n - JAVA_OPTS=-Xms128m -Xmx128m -XX:+ExitOnOutOfMemoryError\n```\n\nFor example, to add debug logging, set `command` as shown in our [docker-compose](examples/docker-compose.yml) file:\n```yaml\n command: --logging.level.zipkin2=DEBUG\n```\n\n## Runtime user\nThe `openzipkin/zipkin` and `openzipkin/zipkin-slim` images run under a nologin\nuser named 'zipkin' with a home directory of '/zipkin'. As this is Alpine Linux\nimage, you won't find many utilities installed, but you can browse contents\nwith a shell like below:\n\n```bash\n$ docker run -it --rm --entrypoint /bin/sh openzipkin/zipkin\n/zipkin $ ls\nBOOT-INF META-INF org run.sh\n```\n\n## Notes\n\n### Container links\nIf using Docker's deprecated container links, you need to set env variables\naccordingly.\n\nEx. If your link name is \"storage\" for an Elasticsearch container:\n```\n ES_HOSTS=http://$STORAGE_PORT_9200_TCP_ADDR:9200\n```\n\nThe above is mentioned only for historical reasons. The OpenZipkin community\ndo not support Docker's deprecated container links.\n\n### MySQL\nIf using an external MySQL server or image, ensure schema and other parameters match the [docs](../zipkin-storage/mysql-v1/README.md#applying-the-schema).\n\n## Building images\n\nTo build `openzipkin/zipkin:test`, from the top-level of the repository, run:\n```bash\n$ build-bin/docker/docker_build openzipkin/zipkin:test\n```\n\nIf you want the slim distribution (openzipkin/zipkin-slim:test), run:\n```bash\n$ DOCKER_TARGET=zipkin-slim build-bin/docker/docker_build openzipkin/zipkin-slim:test\n```\n" }, { "path": "docker/examples/.dockerignore", "content": "# https://docs.docker.com/engine/reference/builder/#dockerignore-file\n**/.*\n\n!./prometheus/create-datasource-and-dashboard.sh\n!./prometheus/prometheus.yml\n" }, { "path": "docker/examples/README.md", "content": "# Zipkin Docker Examples\n\nThis project is configured to run docker containers using\n[docker-compose](https://docs.docker.com/compose/). Note that the default\nconfiguration requires docker compose 1.6.0+ and docker-engine 1.10.0+.\n\nTo start the default docker compose configuration, run:\n\n```bash\n# To use the last released version of zipkin\n$ docker compose up\n# To use the last built version of zipkin\n$ TAG=master docker compose up\n```\n\nView the web UI at $(docker ip):9411. Traces are stored in memory.\n\nTo see specific traces in the UI, select \"zipkin-server\" in the dropdown and\nthen click the \"Find Traces\" button.\n\n## ActiveMQ\n\nYou can collect traces from [ActiveMQ](../test-images/zipkin-activemq/README.md) in addition to HTTP, using the\n`docker-compose-activemq.yml` file. This configuration starts `zipkin` and `zipkin-activemq` in their\nown containers.\n\nTo add ActiveMQ configuration, run:\n```bash\n$ docker compose -f docker-compose-activemq.yml up\n```\n\nThen configure the [ActiveMQ sender](https://github.com/openzipkin/zipkin-reporter-java/blob/master/activemq-client/src/main/java/zipkin2/reporter/activemq/ActiveMQSender.java)\nusing a `brokerUrl` value of `failover:tcp://localhost:61616` or a non-local hostname if in docker.\n\n## Cassandra\n\nYou can store traces in [Cassandra](../test-images/zipkin-cassandra/README.md) instead of memory, using the\n`docker-compose-cassandra.yml` file. This configuration starts `zipkin`, `zipkin-cassandra` and\n`zipkin-dependencies` (cron job) in their own containers.\n\nTo start the Cassandra-backed configuration, run:\n\n```bash\n$ docker compose -f docker-compose-cassandra.yml up\n```\n\nThe `zipkin-dependencies` container is a scheduled task that runs every hour.\nIf you want to see the dependency graph before then, you can run it manually\nin another terminal like so:\n\n```bash\n$ docker compose -f docker-compose-cassandra.yml run --rm --no-deps --entrypoint start-zipkin-dependencies dependencies\n```\n\n## Elasticsearch\n\nYou can store traces in [Elasticsearch](../test-images/zipkin-elasticsearch8/README.md) instead of memory,\nusing the `docker-compose-elasticsearch.yml` file. This configuration starts `zipkin`,\n`zipkin-elasticsearch` and `zipkin-dependencies` (cron job) in their own containers.\n\nTo start the Elasticsearch-backed configuration, run:\n\n```bash\n$ docker compose -f docker-compose-elasticsearch.yml up\n```\n\nThe `zipkin-dependencies` container is a scheduled task that runs every hour.\nIf you want to see the dependency graph before then, you can run it manually\nin another terminal like so:\n\n```bash\n$ docker compose -f docker-compose-elasticsearch.yml run --rm --no-deps --entrypoint start-zipkin-dependencies dependencies\n```\n\n## Kafka\n\nYou can collect traces from [Kafka](../test-images/zipkin-kafka/README.md) in addition to HTTP, using the\n`docker-compose-kafka.yml` file. This configuration starts `zipkin` and `zipkin-kafka` in their\nown containers.\n\nTo add Kafka configuration, run:\n```bash\n$ docker compose -f docker-compose-kafka.yml up\n```\n\nThen configure the [Kafka sender](https://github.com/openzipkin/zipkin-reporter-java/blob/master/kafka/src/main/java/zipkin2/reporter/kafka/KafkaSender.java) using a `bootstrapServers` value of `host.docker.internal:9092` if your application is inside the same docker network or `localhost:19092` if not, but running on the same host.\n\nIn other words, if you are running a sample application on your laptop, you would use `localhost:19092` bootstrap server to send spans to the Kafka broker running in Docker.\n\n### Docker machine and Kafka\n\nIf you are using Docker machine, adjust `KAFKA_ADVERTISED_HOST_NAME` in `docker-compose-kafka.yml`\nand the `bootstrapServers` configuration of the kafka sender to match your Docker host IP (ex. 192.168.99.100:19092).\n\n## MySQL\n\nYou can store traces in [MySQL](../test-images/zipkin-mysql/README.md) instead of memory, using the\n`docker-compose-mysql.yml` file. This configuration starts `zipkin`, `zipkin-mysql` and\n`zipkin-dependencies` (cron job) in their own containers.\n\nTo start the MySQL-backed configuration, run:\n\n```bash\n$ docker compose -f docker-compose-mysql.yml up\n```\n\n## RabbitMQ\n\nYou can collect traces from [RabbitMQ](../test-images/zipkin-rabbitmq/README.md) in addition to HTTP, using the\n`docker-compose-rabbitmq.yml` file. This configuration starts `zipkin` and `zipkin-rabbitmq` in their\nown containers.\n\nTo add RabbitMQ configuration, run:\n```bash\n$ docker compose -f docker-compose-rabbitmq.yml up\n```\n\nThen configure the [RabbitMQ sender](https://github.com/openzipkin/zipkin-reporter-java/blob/master/amqp-client/src/main/java/zipkin2/reporter/amqp/RabbitMQSender.java)\nusing a `host` value of `localhost` or a non-local hostname if in docker.\n\n\n## Pulsar\n\nYou can collect traces from [Pulsar](../test-images/zipkin-pulsar/README.md) in addition to HTTP, using the\n`docker-compose-pulsar.yml` file. This configuration starts `zipkin` and `zipkin-pulsar` in their\nown containers.\n\nTo add Pulsar configuration, run:\n```bash\n$ docker compose -f docker-compose-pulsar.yml up\n```\n\n## Eureka\n\nYou can register Zipkin for service discovery in [Eureka](../test-images/zipkin-eureka/README.md)\nusing the `docker-compose-eureka.yml` file. This configuration starts `zipkin` and `zipkin-eureka`\nin their own containers.\n\nWhen `zipkin` starts, it registers its endpoint into `eureka`. Then, the two [example services](#example)\ndiscover zipkin's endpoint from `eureka` and use it to send spans.\n\nTo try this out, run:\n```bash\n$ docker compose -f docker-compose.yml -f docker-compose-eureka.yml up\n```\n\n## Example\n\nThe docker compose configuration can be extended to host an [example application](https://github.com/openzipkin/brave-example)\nusing the `docker-compose-example.yml` file. That file employs [docker compose overrides](https://docs.docker.com/compose/extends/#multiple-compose-files)\nto add a \"frontend\" and \"backend\" service.\n\nTo add the example configuration, run:\n```bash\n$ docker compose -f docker-compose.yml -f docker-compose-example.yml up\n```\n\nOnce the services start, open http://localhost:8081/\n* This calls the backend (http://localhost:9000/api) and shows its result: a formatted date.\n\nAfterward, you can view traces that went through the backend via http://localhost:9411/zipkin?serviceName=backend\n\n## UI\n\nThe docker compose configuration can be extended to [host the UI](../test-images/zipkin-ui/README.md) on port 80\nusing the `docker-compose-ui.yml` file. That file employs\n[docker compose overrides](https://docs.docker.com/compose/extends/#multiple-compose-files)\nto add an NGINX container and relevant settings.\n\nTo start the NGINX configuration, run:\n\n```bash\n$ docker compose -f docker-compose.yml -f docker-compose-ui.yml up\n```\n\nThis container doubles as a skeleton for creating proxy configuration around\nZipkin like authentication, dealing with CORS with zipkin-js apps, or\nterminating SSL.\n\nIf you want to run the zipkin-ui standalone against a remote zipkin server, you\nneed to set `ZIPKIN_BASE_URL` accordingly:\n\n```bash\n$ docker run -d -p 80:80 \\\n -e ZIPKIN_BASE_URL=http://myfavoritezipkin:9411 \\\n openzipkin/zipkin-ui\n```\n\n## UI Proxy\n\nThe docker compose configuration can be extended to [proxy the UI](../test-images/zipkin-uiproxy/README.md) on port 80\nusing the `docker-compose-uiproxy.yml` file. That file employs\n[docker compose overrides](https://docs.docker.com/compose/extends/#multiple-compose-files) to add an NGINX container and relevant settings.\n\nTo start the NGINX configuration, run:\n\n```bash\n$ docker compose -f docker-compose.yml -f docker-compose-uiproxy.yml up\n```\n\nThis container helps verify the `ZIPKIN_UI_BASEPATH` variable by setting it to\n\"/admin/zipkin\". This means when the compose configuration is up, you can\naccess Zipkin UI at http://localhost/admin/zipkin/\n\n## Prometheus\n\nZipkin comes with a built-in Prometheus metric exporter. The\n`docker-compose-prometheus.yml` file starts Prometheus configured to scrape\nZipkin, exposes it on port `9090`. You can open `$DOCKER_HOST_IP:9090` and\nstart exploring metrics (available on the `/prometheus` endpoint of Zipkin).\n\n`docker-compose-prometheus.yml` also starts a Grafana with authentication\ndisabled, exposing it on port 3000. On startup it's configured with the\nPrometheus instance started by `docker-compose` as a data source, and imports\nthe dashboard published at https://grafana.com/dashboards/1598. This means that,\nafter running `docker-compose ... -f docker-compose-prometheus.yml up`, you\ncan open `$DOCKER_IP:3000/dashboard/db/zipkin-prometheus` and play around with\nthe dashboard.\n" }, { "path": "docker/examples/docker-compose-activemq.yml", "content": "#\n# Copyright The OpenZipkin Authors\n# SPDX-License-Identifier: Apache-2.0\n#\n\n# This file uses the version 2 docker compose file format, described here:\n# https://docs.docker.com/compose/compose-file/#version-2\n#\n# It extends the default configuration from docker-compose.yml to add a test\n# activemq server, which is used as a span transport.\n\nversion: '2.4'\n\nservices:\n activemq:\n image: ghcr.io/openzipkin/zipkin-activemq:${TAG:-latest}\n container_name: activemq\n ports: # expose the ActiveMQ port so apps can publish spans.\n - \"61616:61616\"\n\n zipkin:\n extends:\n file: docker-compose.yml\n service: zipkin\n # slim doesn't include Activemq support, so switch to the larger image\n image: ghcr.io/openzipkin/zipkin:${TAG:-latest}\n environment:\n - ACTIVEMQ_URL=failover:tcp://activemq:61616\n depends_on:\n activemq:\n condition: service_healthy\n" }, { "path": "docker/examples/docker-compose-cassandra.yml", "content": "#\n# Copyright The OpenZipkin Authors\n# SPDX-License-Identifier: Apache-2.0\n#\n\n# This file uses the version 2 docker compose file format, described here:\n# https://docs.docker.com/compose/compose-file/#version-2\n#\n# It extends the default configuration from docker-compose.yml to run the\n# zipkin-cassandra container instead of the zipkin-mysql container.\n\nversion: '2.4'\n\nservices:\n storage:\n image: ghcr.io/openzipkin/zipkin-cassandra:${TAG:-latest}\n # Uncomment to use DSE instead (minimum version 5.1)\n # image: datastax/dse-server:5.1.20\n # environment:\n # - DS_LICENSE=accept\n container_name: cassandra\n # Uncomment to expose the storage port for testing\n # ports:\n # - 9042:9042\n\n # Use Cassandra instead of in-memory storage\n zipkin:\n extends:\n file: docker-compose.yml\n service: zipkin\n # slim doesn't include Cassandra support, so switch to the larger image\n image: ghcr.io/openzipkin/zipkin:${TAG:-latest}\n environment:\n - STORAGE_TYPE=cassandra3\n # When using the test docker image, or have schema pre-installed, you don't need to ensure it\n - CASSANDRA_ENSURE_SCHEMA=false\n # When overriding this value, note the minimum supported version is 3.11.3\n - CASSANDRA_CONTACT_POINTS=cassandra\n # Uncomment to configure authentication\n # - CASSANDRA_USERNAME=cassandra\n # - CASSANDRA_PASSWORD=cassandra\n # Uncomment to enable request logging (TRACE shows query values)\n # command: --logging.level.com.datastax.oss.driver.internal.core.tracker.RequestLogger=TRACE\n depends_on:\n storage:\n condition: service_healthy\n\n dependencies:\n extends:\n file: docker-compose-dependencies.yml\n service: dependencies\n environment:\n - STORAGE_TYPE=${STORAGE_TYPE:-cassandra3}\n - CASSANDRA_CONTACT_POINTS=cassandra\n depends_on:\n storage:\n condition: service_healthy\n" }, { "path": "docker/examples/docker-compose-dependencies.yml", "content": "#\n# Copyright The OpenZipkin Authors\n# SPDX-License-Identifier: Apache-2.0\n#\n\nversion: '2.4'\n\nservices:\n # Adds a cron to process spans since midnight every hour, and all spans each day\n # This data is served by http://192.168.99.100:8080/dependency\n #\n # For more details, see https://github.com/openzipkin/docker-zipkin-dependencies\n dependencies:\n image: ghcr.io/openzipkin/zipkin-dependencies\n container_name: dependencies\n user: root\n entrypoint: /usr/sbin/crond -f\n # environment:\n # Uncomment to see dependency processing logs\n # - ZIPKIN_LOG_LEVEL=DEBUG\n # Uncomment to adjust memory used by the dependencies job\n # - JAVA_OPTS=-verbose:gc -Xms1G -Xmx1G\n" }, { "path": "docker/examples/docker-compose-elasticsearch.yml", "content": "#\n# Copyright The OpenZipkin Authors\n# SPDX-License-Identifier: Apache-2.0\n#\n\n# This file uses the version 2 docker compose file format, described here:\n# https://docs.docker.com/compose/compose-file/#version-2\n#\n# It extends the default configuration from docker-compose.yml to run the\n# zipkin-elasticsearch container instead of the zipkin-mysql container.\n\nversion: '2.4'\n\nservices:\n storage:\n image: ghcr.io/openzipkin/zipkin-elasticsearch8:${TAG:-latest}\n container_name: elasticsearch\n # Uncomment to expose the storage port for testing\n # ports:\n # - 9200:9200\n\n # Use Elasticsearch instead of in-memory storage\n zipkin:\n extends:\n file: docker-compose.yml\n service: zipkin\n environment:\n - STORAGE_TYPE=elasticsearch\n # Point the zipkin at the storage backend\n - ES_HOSTS=elasticsearch:9200\n # Uncomment to see requests to and from elasticsearch\n # - ES_HTTP_LOGGING=BODY\n depends_on:\n storage:\n condition: service_healthy\n\n dependencies:\n extends:\n file: docker-compose-dependencies.yml\n service: dependencies\n environment:\n - STORAGE_TYPE=elasticsearch\n - ES_HOSTS=elasticsearch\n depends_on:\n storage:\n condition: service_healthy\n" }, { "path": "docker/examples/docker-compose-eureka.yml", "content": "#\n# Copyright The OpenZipkin Authors\n# SPDX-License-Identifier: Apache-2.0\n#\n\n# This file uses the version 2 docker compose file format, described here:\n# https://docs.docker.com/compose/compose-file/#version-2\n#\n# It extends the default configuration from docker-compose.yml to register\n# zipkin into a test eureka server.\n\nversion: '2.4'\n\nservices:\n eureka:\n image: ghcr.io/openzipkin/zipkin-eureka:${TAG:-latest}\n container_name: eureka\n# Uncomment to require authentication\n# environment:\n# - EUREKA_USERNAME=username\n# - EUREKA_PASSWORD=password\n# Uncomment to expose the eureka port for testing\n# ports:\n# - 8761:8761\n\n zipkin:\n extends:\n file: docker-compose.yml\n service: zipkin\n environment:\n - EUREKA_SERVICE_URL=http://eureka:8761/eureka/v2\n # Uncomment to authenticate eureka\n #- EUREKA_SERVICE_URL=http://username:password@eureka:8761/eureka/v2\n - EUREKA_HOSTNAME=zipkin\n depends_on:\n eureka:\n condition: service_healthy\n\n # Generate traffic by hitting http://localhost:8081\n frontend:\n image: ghcr.io/openzipkin/brave-example:armeria\n container_name: frontend\n entrypoint: start-frontend\n environment:\n - EUREKA_SERVICE_URL=http://eureka:8761/eureka/v2\n # Uncomment to authenticate eureka\n #- EUREKA_SERVICE_URL=http://username:password@eureka:8761/eureka/v2\n ports:\n - 8081:8081\n depends_on:\n backend:\n condition: service_healthy\n zipkin:\n condition: service_healthy\n\n # Serves the /api endpoint the frontend uses\n backend:\n image: ghcr.io/openzipkin/brave-example:armeria\n container_name: backend\n entrypoint: start-backend\n environment:\n - EUREKA_SERVICE_URL=http://eureka:8761/eureka/v2\n # Uncomment to authenticate eureka\n #- EUREKA_SERVICE_URL=http://username:password@eureka:8761/eureka/v2\n depends_on:\n zipkin:\n condition: service_healthy\n" }, { "path": "docker/examples/docker-compose-example.yml", "content": "#\n# Copyright The OpenZipkin Authors\n# SPDX-License-Identifier: Apache-2.0\n#\n\n# Format version 2.1 was introduced with Docker Compose v1.9\n# We need Docker Compose v1.9+ for unset variable interpolation\nversion: \"2.1\"\n\nservices:\n # Generate traffic by hitting http://localhost:8081\n frontend:\n container_name: frontend\n image: ghcr.io/openzipkin/brave-example:${PROJECT:-armeria}\n entrypoint: start-frontend\n ports:\n - 8081:8081\n depends_on:\n backend:\n condition: service_healthy\n zipkin:\n condition: service_started\n # Serves the /api endpoint the frontend uses\n backend:\n container_name: backend\n image: ghcr.io/openzipkin/brave-example:${PROJECT:-armeria}\n entrypoint: start-backend\n depends_on:\n zipkin:\n condition: service_started\n" }, { "path": "docker/examples/docker-compose-kafka.yml", "content": "#\n# Copyright The OpenZipkin Authors\n# SPDX-License-Identifier: Apache-2.0\n#\n\n# This file uses the version 2 docker compose file format, described here:\n# https://docs.docker.com/compose/compose-file/#version-2\n#\n# It extends the default configuration from docker-compose.yml to add a test\n# kafka server, which is used as a span transport.\n\nversion: '2.4'\n\nservices:\n kafka:\n image: ghcr.io/openzipkin/zipkin-kafka:${TAG:-latest}\n container_name: kafka\n # If using docker machine, uncomment the below and set your bootstrap\n # server list to 192.168.99.100:19092\n # environment:\n # - KAFKA_ADVERTISED_HOST_NAME=192.168.99.100\n ports:\n # Processes on the Docker host can set bootstrap server list to localhost:19092\n - 19092:19092\n\n zipkin:\n extends:\n file: docker-compose.yml\n service: zipkin\n # slim doesn't include Kafka support, so switch to the larger image\n image: ghcr.io/openzipkin/zipkin:${TAG:-latest}\n environment:\n - KAFKA_BOOTSTRAP_SERVERS=kafka:9092\n depends_on:\n kafka:\n condition: service_healthy\n" }, { "path": "docker/examples/docker-compose-mysql.yml", "content": "#\n# Copyright The OpenZipkin Authors\n# SPDX-License-Identifier: Apache-2.0\n#\n\n# This file uses the version 2 docker compose file format, described here:\n# https://docs.docker.com/compose/compose-file/#version-2\n#\n# This runs the zipkin and zipkin-mysql containers, using docker-compose's\n# default networking to wire the containers together.\n#\n# Note that this file is meant for learning Zipkin, not production deployments.\n\nversion: '2.4'\n\nservices:\n storage:\n image: ghcr.io/openzipkin/zipkin-mysql:${TAG:-latest}\n container_name: mysql\n # Uncomment to expose the storage port for testing\n # ports:\n # - 3306:3306\n\n # Use MySQL instead of in-memory storage\n zipkin:\n extends:\n file: docker-compose.yml\n service: zipkin\n # slim doesn't include MySQL support, so switch to the larger image\n image: ghcr.io/openzipkin/zipkin:${TAG:-latest}\n environment:\n - STORAGE_TYPE=mysql\n - MYSQL_HOST=storage\n # Add the baked-in username and password for the zipkin-mysql image\n - MYSQL_USER=zipkin\n - MYSQL_PASS=zipkin\n depends_on:\n storage:\n condition: service_healthy\n\n dependencies:\n extends:\n file: docker-compose-dependencies.yml\n service: dependencies\n environment:\n - STORAGE_TYPE=mysql\n - MYSQL_HOST=storage\n # Add the baked-in username and password for the zipkin-mysql image\n - MYSQL_USER=zipkin\n - MYSQL_PASS=zipkin\n depends_on:\n storage:\n condition: service_healthy\n" }, { "path": "docker/examples/docker-compose-prometheus.yml", "content": "#\n# Copyright The OpenZipkin Authors\n# SPDX-License-Identifier: Apache-2.0\n#\n\n# This file uses the version 2 docker compose file format, described here:\n# https://docs.docker.com/compose/compose-file/#version-2\n#\n# This runs containers that collect data for our Grafana dashboard\n#\n# Note that this file is meant for learning Zipkin, not production deployments.\n\nversion: '2.4'\n\nservices:\n prometheus:\n # Use a quay.io mirror to prevent build outages due to Docker Hub pull quotas\n # Use latest from https://quay.io/repository/prometheus/prometheus?tab=tags\n image: quay.io/prometheus/prometheus:v2.55.1\n container_name: prometheus\n ports:\n - 9090:9090\n depends_on:\n zipkin:\n condition: service_healthy\n volumes:\n - ./prometheus/prometheus.yml:/etc/prometheus/prometheus.yml\n\n grafana:\n # Use a quay.io mirror to prevent build outages due to Docker Hub pull quotas\n # Use latest from https://quay.io/repository/giantswarm/grafana?tab=tags\n image: quay.io/giantswarm/grafana:7.5.12\n container_name: grafana\n ports:\n - 3000:3000\n depends_on:\n - prometheus\n environment:\n - GF_AUTH_ANONYMOUS_ENABLED=true\n - GF_AUTH_ANONYMOUS_ORG_ROLE=Admin\n\n setup_grafana_datasource:\n # This is an arbitrary small image that has curl installed\n # Use a quay.io mirror to prevent build outages due to Docker Hub pull quotas\n # Use latest from https://quay.io/repository/cilium/alpine-curl?tab=tags\n image: quay.io/cilium/alpine-curl:v1.10.0\n container_name: setup_grafana_datasource\n depends_on:\n - grafana\n volumes:\n - ./prometheus/create-datasource-and-dashboard.sh:/tmp/create.sh:ro\n working_dir: /tmp\n entrypoint: /tmp/create.sh\n" }, { "path": "docker/examples/docker-compose-pulsar.yml", "content": "#\n# Copyright The OpenZipkin Authors\n# SPDX-License-Identifier: Apache-2.0\n#\n\n# This file uses the version 2 docker compose file format, described here:\n# https://docs.docker.com/compose/compose-file/#version-2\n#\n# It extends the default configuration from docker-compose.yml to add a test\n# pulsar server, which is used as a span transport.\n\nversion: '2.4'\n\nservices:\n pulsar:\n image: ghcr.io/openzipkin/zipkin-pulsar:${TAG:-latest}\n container_name: pulsar\n ports: # expose the pulsar port so apps can publish spans.\n - \"6650:6650\"\n # - \"8080:8080\" # uncomment to expose the pulsar http port.\n\n zipkin:\n extends:\n file: docker-compose.yml\n service: zipkin\n # slim doesn't include Pulsar support, so switch to the larger image\n image: ghcr.io/openzipkin/zipkin:${TAG:-latest}\n environment:\n - PULSAR_SERVICE_URL=pulsar://pulsar:6650\n depends_on:\n pulsar:\n condition: service_healthy\n" }, { "path": "docker/examples/docker-compose-rabbitmq.yml", "content": "#\n# Copyright The OpenZipkin Authors\n# SPDX-License-Identifier: Apache-2.0\n#\n\n# This file uses the version 2 docker compose file format, described here:\n# https://docs.docker.com/compose/compose-file/#version-2\n#\n# It extends the default configuration from docker-compose.yml to add a test\n# rabbitmq server, which is used as a span transport.\n\nversion: '2.4'\n\nservices:\n rabbitmq:\n image: ghcr.io/openzipkin/zipkin-rabbitmq:${TAG:-latest}\n container_name: rabbitmq\n ports: # expose the rabbitmq port so apps can publish spans.\n - \"5672:5672\"\n\n zipkin:\n extends:\n file: docker-compose.yml\n service: zipkin\n # slim doesn't include RabbitMQ support, so switch to the larger image\n image: ghcr.io/openzipkin/zipkin:${TAG:-latest}\n environment:\n - RABBIT_ADDRESSES=rabbitmq:5672\n depends_on:\n rabbitmq:\n condition: service_healthy\n" }, { "path": "docker/examples/docker-compose-ui.yml", "content": "#\n# Copyright The OpenZipkin Authors\n# SPDX-License-Identifier: Apache-2.0\n#\n\n# This file uses the version 2 docker compose file format, described here:\n# https://docs.docker.com/compose/compose-file/#version-2\n#\n# It extends the default configuration from docker-compose.yml, hosting the\n# ui on port 80 using NGINX\n\nversion: '2.4'\n\nservices:\n zipkin-ui:\n image: ghcr.io/openzipkin/zipkin-ui:${TAG:-latest}\n container_name: zipkin-ui\n environment:\n # Change this if connecting to a different zipkin server\n - ZIPKIN_BASE_URL=http://zipkin:9411\n ports:\n - 80:80\n depends_on:\n zipkin:\n condition: service_healthy\n" }, { "path": "docker/examples/docker-compose-uiproxy.yml", "content": "#\n# Copyright The OpenZipkin Authors\n# SPDX-License-Identifier: Apache-2.0\n#\n\n# This file uses the version 2 docker compose file format, described here:\n# https://docs.docker.com/compose/compose-file/#version-2\n#\n# It extends the default configuration from docker-compose.yml, hosting the\n# ui on port 80 using NGINX\n\nversion: '2.4'\n\nservices:\n zipkin-uiproxy:\n image: ghcr.io/openzipkin/zipkin-uiproxy:${TAG:-latest}\n container_name: zipkin-uiproxy\n environment:\n # This allows hitting the UI on the host by http://localhost/admin/zipkin\n - ZIPKIN_UI_BASEPATH=/admin/zipkin\n ports:\n - 80:80\n depends_on:\n zipkin:\n condition: service_healthy\n\n zipkin:\n extends:\n file: docker-compose.yml\n service: zipkin\n environment:\n # This must match what's set in zipkin-uiproxy\n - ZIPKIN_UI_BASEPATH=/admin/zipkin\n" }, { "path": "docker/examples/docker-compose.yml", "content": "#\n# Copyright The OpenZipkin Authors\n# SPDX-License-Identifier: Apache-2.0\n#\n\n# This file uses the version 2 docker compose file format, described here:\n# https://docs.docker.com/compose/compose-file/#version-2\n#\n# This runs the zipkin slim container, using docker-compose's default networking\n# to wire other containers together.\n#\n# Note that this file is meant for learning Zipkin, not production deployments.\n\nversion: '2.4'\n\nservices:\n # The zipkin process services the UI, and also exposes a POST endpoint that\n # instrumentation can send trace data to.\n zipkin:\n image: ghcr.io/openzipkin/zipkin-slim:${TAG:-latest}\n container_name: zipkin\n # Environment settings are defined here https://github.com/openzipkin/zipkin/blob/master/zipkin-server/README.md#environment-variables\n environment:\n - STORAGE_TYPE=mem\n # Uncomment to enable self-tracing\n # - SELF_TRACING_ENABLED=true\n # Uncomment to increase heap size\n # - JAVA_OPTS=-Xms128m -Xmx128m -XX:+ExitOnOutOfMemoryError\n ports:\n # Port used for the Zipkin UI and HTTP Api\n - 9411:9411\n # Uncomment to enable debug logging\n # command: --logging.level.zipkin2=DEBUG\n\n" }, { "path": "docker/examples/prometheus/create-datasource-and-dashboard.sh", "content": "#!/bin/sh\n#\n# Copyright The OpenZipkin Authors\n# SPDX-License-Identifier: Apache-2.0\n#\n\nset -xeuo pipefail\n\nif ! curl --retry 5 --retry-connrefused --retry-delay 0 -sf http://grafana:3000/api/datasources/name/prom; then\n curl -sf -X POST -H \"Content-Type: application/json\" \\\n --data-binary '{\"name\":\"prom\",\"type\":\"prometheus\",\"url\":\"http://prometheus:9090\",\"access\":\"proxy\",\"isDefault\":true}' \\\n http://grafana:3000/api/datasources\nfi\n\ndashboard_id=1598\nlast_revision=$(curl -sf https://grafana.com/api/dashboards/${dashboard_id}/revisions | grep '\"revision\":' | sed 's/ *\"revision\": \\([0-9]*\\),/\\1/' | sort -n | tail -1)\n\necho '{\"dashboard\": ' > data.json\ncurl -s https://grafana.com/api/dashboards/${dashboard_id}/revisions/${last_revision}/download >> data.json\necho ', \"inputs\": [{\"name\": \"DS_PROMETHEUS\", \"pluginId\": \"prometheus\", \"type\": \"datasource\", \"value\": \"prom\"}], \"overwrite\": false}' >> data.json\ncurl --retry-connrefused --retry 5 --retry-delay 0 -sf \\\n -X POST -H \"Content-Type: application/json\" \\\n --data-binary @data.json \\\n http://grafana:3000/api/dashboards/import\n" }, { "path": "docker/examples/prometheus/prometheus.yml", "content": "#\n# Copyright The OpenZipkin Authors\n# SPDX-License-Identifier: Apache-2.0\n#\n\nglobal:\n scrape_interval: 15s # Set the scrape interval to every 15 seconds. Default is every 1 minute.\n evaluation_interval: 15s # Evaluate rules every 15 seconds. The default is every 1 minute.\n\nscrape_configs:\n - job_name: 'prometheus'\n static_configs:\n - targets: ['localhost:9090']\n - job_name: 'zipkin'\n scrape_interval: 5s\n metrics_path: '/prometheus'\n static_configs:\n - targets: ['zipkin:9411']\n" }, { "path": "docker/start-zipkin", "content": "#!/bin/sh\n#\n# Copyright The OpenZipkin Authors\n# SPDX-License-Identifier: Apache-2.0\n#\n\n# ENTRYPOINT script that starts Zipkin\nset -eu\n\nSTORAGE_TYPE=${STORAGE_TYPE:-mem}\n\n# Configure the Docker HEALTHCHECK\nexport HEALTHCHECK_PORT=${QUERY_PORT:-9411}\n\nif [ \"${STORAGE_TYPE}\" = \"mem\" ]; then\n # When using in-memory provider, allocate 160m, most of which for trace storage\n JAVA_OPTS=${JAVA_OPTS:-\"-Xms160m -Xmx160m -XX:+ExitOnOutOfMemoryError\"}\nfi\n\n# MODULE_OPTS is not set in the zipkin-slim dist, so use it to detect if this is a slim build\nif [ -z \"${MODULE_OPTS+x}\" ]; then\n # Allocate less memory when using the slim build\n JAVA_OPTS=${JAVA_OPTS:-\"-Xms64m -Xmx64m -XX:+ExitOnOutOfMemoryError\"}\n\n # Use main class directly if there are no modules, as it measured 14% faster from JVM running to\n # available verses PropertiesLauncher when using Zipkin was based on Spring Boot 2.1\n exec java ${JAVA_OPTS} -cp '.:BOOT-INF/lib/*:BOOT-INF/classes' zipkin.server.ZipkinServer \"$@\"\nelse\n JAVA_OPTS=${JAVA_OPTS:-\"-Xms96m -Xmx96m -XX:+ExitOnOutOfMemoryError\"}\n\n # Disable Log4j2 JMX extensions when running the full build\n exec java ${MODULE_OPTS} ${JAVA_OPTS} -cp . \\\n -Dlog4j2.disable.jmx=true \\\n org.springframework.boot.loader.launch.PropertiesLauncher \"$@\"\nfi\n" }, { "path": "docker/test-images/zipkin-activemq/Dockerfile", "content": "#\n# Copyright The OpenZipkin Authors\n# SPDX-License-Identifier: Apache-2.0\n#\n\n# java_version is used for install and runtime layers of zipkin-activemq\n#\n# Use latest version here: https://github.com/orgs/openzipkin/packages/container/package/java\n# This is defined in many places because Docker has no \"env\" script functionality unless you use\n# docker-compose: When updating, update everywhere.\nARG java_version=21.0.7_p6\n\n# We copy files from the context into a scratch container first to avoid a problem where docker and\n# docker compose don't share layer hashes https://github.com/docker/compose/issues/883 normally.\n# COPY --from= works around the issue.\nFROM scratch as scratch\n\nCOPY build-bin/docker/docker-healthcheck /docker-bin/\nCOPY docker/test-images/zipkin-activemq/start-activemq /docker-bin/\n\nFROM ghcr.io/openzipkin/java:${java_version} as install\n\nWORKDIR /install\n\n# Use latest version from https://activemq.apache.org/components/classic/download/\nARG activemq_version=6.1.5\n\n# Download the distribution\nRUN \\\n# Connection resets are frequent in GitHub Actions workflows \\\nwget --random-wait --tries=5 -qO- \\\n# Remove junk from the distribution while downloading it\nhttps://archive.apache.org/dist/activemq/${activemq_version}/apache-activemq-${activemq_version}-bin.tar.gz| tar xz \\\n --wildcards --exclude=examples --exclude=webapps-demo --strip=1\n\n# Note: this uses the JDK image as ActiveMQ has a module dependency on JMX,\n# which isn't in our JRE.\nFROM ghcr.io/openzipkin/java:${java_version} as zipkin-activemq\nLABEL org.opencontainers.image.description=\"ActiveMQ Classic on OpenJDK and Alpine Linux\"\nARG activemq_version=6.1.5\nLABEL activemq-version=$activemq_version\n\n# Add HEALTHCHECK and ENTRYPOINT scripts into the default search path\nCOPY --from=scratch /docker-bin/* /usr/local/bin/\n# We use start period of 30s to avoid marking the container unhealthy on slow or contended CI hosts\nHEALTHCHECK --interval=1s --start-period=30s --timeout=5s CMD [\"docker-healthcheck\"]\nENTRYPOINT [\"start-activemq\"]\n\n# All content including binaries and logs write under WORKDIR\nARG USER=activemq\nWORKDIR /${USER}\nENV ACTIVEMQ_HOME=/${USER}\n\n# Ensure the process doesn't run as root\nRUN adduser -g '' -h ${PWD} -D ${USER}\nUSER ${USER}\n\n# Copy binaries and config we installed earlier\nCOPY --from=install --chown=${USER} /install .\n\n# Use to set heap, trust store or other system properties.\nENV JAVA_OPTS=\"-Xms64m -Xmx64m -XX:+ExitOnOutOfMemoryError\"\nEXPOSE 1883 5672 8161 61613 61614 61616\n" }, { "path": "docker/test-images/zipkin-activemq/README.md", "content": "## zipkin-activemq Docker image\n\nThe `zipkin-activemq` testing image runs ActiveMQ Classic for [ActiveMQ collector](../../../zipkin-collector/activemq)\nintegration.\n\nTo build `openzipkin/zipkin-activemq:test`, from the top-level of the repository, run:\n```bash\n$ DOCKER_FILE=docker/test-images/zipkin-activemq/Dockerfile build-bin/docker/docker_build openzipkin/zipkin-activemq:test\n```\n\nYou can use the env variable `JAVA_OPTS` to change settings such as heap size for ActiveMQ.\n" }, { "path": "docker/test-images/zipkin-activemq/start-activemq", "content": "#!/bin/sh\n#\n# Copyright The OpenZipkin Authors\n# SPDX-License-Identifier: Apache-2.0\n#\n\n# ENTRYPOINT script that starts ActiveMQ\n#\n# This intentionally locates config using the current working directory, in order to consolidate\n# Dockerfile instructions to WORKDIR\nset -eu\n\n# Configure the Docker HEALTHCHECK\n# Configure the Docker HEALTHCHECK\nexport HEALTHCHECK_PORT=61616\nexport HEALTHCHECK_KIND=tcp\n\necho Starting ActiveMQ\nexec bin/activemq console\n\n" }, { "path": "docker/test-images/zipkin-cassandra/Dockerfile", "content": "#\n# Copyright The OpenZipkin Authors\n# SPDX-License-Identifier: Apache-2.0\n#\n\n# java_version is used for install and runtime layers of zipkin-cassandra\n#\n# Use latest version here: https://github.com/orgs/openzipkin/packages/container/package/java\n# This is defined in many places because Docker has no \"env\" script functionality unless you use\n# docker-compose: When updating, update everywhere.\nARG java_version=21.0.7_p6\n\n# We copy files from the context into a scratch container first to avoid a problem where docker and\n# docker compose don't share layer hashes https://github.com/docker/compose/issues/883 normally.\n# COPY --from= works around the issue.\nFROM scratch as scratch\n\nCOPY build-bin/docker/docker-healthcheck /docker-bin/\nCOPY docker/test-images/zipkin-cassandra/start-cassandra /docker-bin/\nCOPY docker/test-images/zipkin-cassandra/install.sh /install/\nCOPY zipkin-storage/cassandra/src/main/resources/*.cql /zipkin-schemas/\n\nFROM ghcr.io/openzipkin/java:${java_version} as install\n\n# Use latest stable version: https://cassandra.apache.org/download/\n# This is defined in many places because Docker has no \"env\" script functionality unless you use\n# docker-compose: When updating, update everywhere.\nARG cassandra_version=4.1.8\nENV CASSANDRA_VERSION=$cassandra_version\nWORKDIR /install\n\nCOPY --from=scratch /zipkin-schemas/* ./zipkin-schemas/\nCOPY --from=scratch /install/install.sh /tmp/\nRUN /tmp/install.sh && rm /tmp/install.sh\n\nFROM ghcr.io/openzipkin/java:${java_version}-jre as zipkin-cassandra\nLABEL org.opencontainers.image.description=\"Cassandra on OpenJDK and Alpine Linux with Zipkin keyspaces pre-installed\"\nARG cassandra_version=4.1.8\nLABEL cassandra-version=$cassandra_version\nENV CASSANDRA_VERSION=$cassandra_version\n\n# Add HEALTHCHECK and ENTRYPOINT scripts into the default search path\nCOPY --from=scratch /docker-bin/* /usr/local/bin/\n# We use start period of 30s to avoid marking the container unhealthy on slow or contended CI hosts\nHEALTHCHECK --interval=1s --start-period=30s --timeout=5s CMD [\"docker-healthcheck\"]\nENTRYPOINT [\"start-cassandra\"]\n\n# All content including binaries and logs write under WORKDIR\nARG USER=cassandra\nWORKDIR /${USER}\n\n# Ensure the process doesn't run as root\nRUN adduser -g '' -h ${PWD} -D ${USER}\nUSER ${USER}\n\n# Copy binaries and config we installed earlier\nCOPY --from=install --chown=${USER} /install .\n\n# Set variables Cassandra's start script wants\nENV JAVA_OPTS=\"-Xms256m -Xmx256m -XX:+ExitOnOutOfMemoryError -Djava.net.preferIPv4Stack=true\"\nENV LOGGING_LEVEL=WARN\n\nEXPOSE 9042\n" }, { "path": "docker/test-images/zipkin-cassandra/README.md", "content": "## zipkin-cassandra Docker image\n\nThe `zipkin-cassandra` testing image runs Cassandra 4.x initialized with Zipkin's schema for\n[Cassandra storage](../../../zipkin-storage/cassandra) integration.\n\nBesides norms defined in [docker-java](https://github.com/openzipkin/docker-java), this accepts the\nfollowing environment variables:\n\n * `LOGGING_LEVEL`: Root Log4J logging level sent to stdout. Defaults to \"WARN\"\n\nTo build `openzipkin/zipkin-cassandra:test`, from the top-level of the repository, run:\n```bash\n$ DOCKER_FILE=docker/test-images/zipkin-cassandra/Dockerfile build-bin/docker/docker_build openzipkin/zipkin-cassandra:test\n```\n" }, { "path": "docker/test-images/zipkin-cassandra/install.sh", "content": "#!/bin/sh\n#\n# Copyright The OpenZipkin Authors\n# SPDX-License-Identifier: Apache-2.0\n#\n\n# install script used only in building the docker image, but not at runtime.\n# This uses relative path so that you can change the home dir without editing this file.\n# This also trims dependencies to only those used at runtime.\nset -eux\n\necho \"*** Installing Cassandra\"\n\n# Create directories for the Java classpath\nmkdir classes lib\n\ncat > pom.xml <<-'EOF'\n\n 4.0.0\n\n io.zipkin.cassandra\n get-cassandra\n 0.1.0-SNAPSHOT\n pom\n\n \n \n org.apache.cassandra\n cassandra-all\n ${cassandra.version}\n \n \n net.java.dev.jna\n *\n \n \n com.github.jbellis\n *\n \n \n org.slf4j\n *\n \n \n ch.qos.logback\n *\n \n \n \n \n \n net.java.dev.jna\n jna\n 5.16.0\n \n \n \n com.github.jbellis\n jamm\n 0.4.0\n \n \n \n org.slf4j\n slf4j-log4j12\n 1.7.36\n \n \n\nEOF\nmvn -q --batch-mode -DoutputDirectory=lib \\\n -Dcassandra.version=${CASSANDRA_VERSION} \\\n org.apache.maven.plugins:maven-dependency-plugin:3.8.1:copy-dependencies\nrm pom.xml\n\n# Get a version of ObjectSizes.java that compiles with jamm 0.4.0\nwget --random-wait --tries=5 -qO ObjectSizes.java \\\n https://raw.githubusercontent.com/apache/cassandra/refs/tags/cassandra-5.0.3/src/java/org/apache/cassandra/utils/ObjectSizes.java\n# Rename a public method back to the same name as used in Cassandra 4.1.\nsed -i 's/sizeOnHeapExcludingDataOf/sizeOnHeapExcludingData/g' ObjectSizes.java\n# Compile it into classes, which overrides the same class from Cassandra 4.1.\njavac -cp 'lib/*' -d classes ObjectSizes.java\n\n# Make sure you use relative paths in references like this, so that installation\n# is decoupled from runtime\nmkdir -p conf data commitlog saved_caches hints triggers\n\n# Generate basic required configuration from default values\ncat > conf/cassandra.yaml <<-'EOF'\npartitioner: org.apache.cassandra.dht.Murmur3Partitioner\ncommitlog_sync: periodic\ncommitlog_sync_period_in_ms: 10000\nendpoint_snitch: SimpleSnitch\n\n# override via -Dcassandra.storage_port=7000\nstorage_port: 7000\n# override via -Dcassandra.native_transport_port=9042\nnative_transport_port: 9042\nlisten_address: 127.0.0.1\nstart_native_transport: true\nseed_provider:\n - class_name: org.apache.cassandra.locator.SimpleSeedProvider\n parameters:\n - seeds: \"127.0.0.1\"\n\n# Disabled by default in Cassandra 4\nenable_sasi_indexes: true\nEOF\n\ntemp_storage_port=7010\ntemp_native_transport_port=9052\n\n# Keep INFO logs as if this fails in CI, we'll get more insight. These aren't displayed unless we\n# have a crash.\ncat > conf/log4j.properties <<-'EOF'\nlog4j.rootLogger=INFO, stdout\n\nlog4j.appender.stdout=org.apache.log4j.ConsoleAppender\nlog4j.appender.stdout.layout=org.apache.log4j.PatternLayout\nlog4j.appender.stdout.layout.ConversionPattern=[%d] %p %m (%c)%n\nlog4j.appender.stdout.Target=System.out\nEOF\n\ncat zipkin-schemas/zipkin2-schema.cql zipkin-schemas/zipkin2-schema-indexes.cql > schema\n\n# read_repair_chance options were removed and make Cassandra crash starting in v4\n# See https://cassandra.apache.org/doc/latest/operating/read_repair.html#background-read-repair\nsed -i '/read_repair_chance/d' schema\n\n# Run cassandra on a different port temporarily in order to setup the schema.\n#\n# We also add exports and opens from both Cassandra v4 and v5, except for\n# attach, compiler and rmi because our JRE excludes these modules.\n#\n# Merging makes adding Cassandra v5 easier and lets us share a common JRE 17+\n# with other test images even if Cassandra v4 will never officially support it.\n# https://github.com/apache/cassandra/blob/cassandra-4.1.8/conf/jvm11-server.options\n# https://github.com/apache/cassandra/blob/cassandra-5.0.3/conf/jvm17-server.options\n#\n# Finally, we allow security manager to prevent JRE 21 crashing when Cassandra\n# attempts ThreadAwareSecurityManager.install()\njava -cp 'classes:lib/*' -Xms64m -Xmx64m -XX:+ExitOnOutOfMemoryError -verbose:gc \\\n -Djava.security.manager=allow \\\n -Djdk.attach.allowAttachSelf=true \\\n --add-exports java.base/jdk.internal.misc=ALL-UNNAMED \\\n --add-exports java.base/jdk.internal.ref=ALL-UNNAMED \\\n --add-exports java.base/sun.nio.ch=ALL-UNNAMED \\\n --add-exports java.sql/java.sql=ALL-UNNAMED \\\n --add-exports java.base/java.lang.ref=ALL-UNNAMED \\\n --add-exports jdk.unsupported/sun.misc=ALL-UNNAMED \\\n --add-opens java.base/java.lang.module=ALL-UNNAMED \\\n --add-opens java.base/jdk.internal.loader=ALL-UNNAMED \\\n --add-opens java.base/jdk.internal.ref=ALL-UNNAMED \\\n --add-opens java.base/jdk.internal.reflect=ALL-UNNAMED \\\n --add-opens java.base/jdk.internal.math=ALL-UNNAMED \\\n --add-opens java.base/jdk.internal.module=ALL-UNNAMED \\\n --add-opens java.base/jdk.internal.util.jar=ALL-UNNAMED \\\n --add-opens jdk.management/com.sun.management.internal=ALL-UNNAMED \\\n --add-opens java.base/java.io=ALL-UNNAMED \\\n --add-opens java.base/java.nio=ALL-UNNAMED \\\n --add-opens java.base/sun.nio.ch=ALL-UNNAMED \\\n --add-opens java.base/java.io=ALL-UNNAMED \\\n --add-opens java.base/java.lang.reflect=ALL-UNNAMED \\\n --add-opens java.base/java.lang=ALL-UNNAMED \\\n --add-opens java.base/java.util=ALL-UNNAMED \\\n --add-opens java.base/java.nio=ALL-UNNAMED \\\n --add-opens java.base/java.util.concurrent=ALL-UNNAMED \\\n --add-opens java.base/java.util.concurrent.atomic=ALL-UNNAMED \\\n -Dcassandra.storage_port=${temp_storage_port} \\\n -Dcassandra.native_transport_port=${temp_native_transport_port} \\\n -Dcassandra.storagedir=${PWD} \\\n -Dcassandra.triggers_dir=${PWD}/triggers \\\n -Dcassandra.config=file:${PWD}/conf/cassandra.yaml \\\n -Dlog4j.configuration=file:${PWD}/conf/log4j.properties \\\n org.apache.cassandra.service.CassandraDaemon > temp_cassandra.out 2>&1 &\ntemp_cassandra_pid=$!\n\nis_cassandra_alive() {\n if ! kill -0 ${temp_cassandra_pid}; then\n cat temp_cassandra.out\n maybe_crash_file=hs_err_pid${temp_cassandra_pid}.log\n test -f $maybe_crash_file && cat $maybe_crash_file\n return 1\n fi\n return 0\n}\n\nis_cassandra_alive || exit 1\n\necho \"*** Installing cqlsh\"\n# cqlsh 4.x is not compatible with Python 3.12 by default.\n# See https://issues.apache.org/jira/browse/CASSANDRA-19206\npython3_version=3.12\napk add --update --no-cache python3=~${python3_version}\n# Installing cqlsh requires cffi package. Normally this doesn't need\n# to be compiled, but something isn't right with aarch64 when installing\n# cqlsh it needs to build cffi. To unblock support for aarch64, adding\n# the following are necessary for compiling cffi. If pip someday changes and\n# doesn't compile cffi on aarch64 then we can remove these dependencies.\n# libev is required when using python 3.12\n# TODO: remove git when https://github.com/jeffwidman/cqlsh/pull/37 is released\napk add --update --no-cache gcc python3-dev=~${python3_version} musl-dev libffi-dev libev libev-dev git\n# PEP 668 protects against mixing system and pip packages. Setup virtual env to avoid this.\npython3 -m venv .venv\n. .venv/bin/activate\npython3 -m ensurepip --upgrade\npip install --upgrade pip setuptools wheel\n# Installing from trunk since released versions have dependency on old setup tools\npip install -Iq git+https://github.com/apache/cassandra-python-driver@trunk\npip install cqlsh\ncql() {\n cqlsh \"$@\" 127.0.0.1 ${temp_native_transport_port}\n}\n\n# Excessively long timeout to avoid having to create an ENV variable, decide its name, etc.\ntimeout=180\necho \"Will wait up to ${timeout} seconds for Cassandra to come up before installing Schema\"\nwhile [ \"$timeout\" -gt 0 ] && ! cql -e 'SHOW VERSION' > /dev/null 2>&1; do\n is_cassandra_alive || exit 1\n sleep 1\n timeout=$(($timeout - 1))\ndone\n\necho \"*** Importing Scheme\"\ncat schema | cql --debug && rm schema\n\necho \"*** Stopping Cassandra\"\nkill ${temp_cassandra_pid}\nwait\n\n# The image will use a less chatty Log4J conf which only logs warnings (to stdout).\ncat > conf/log4j.properties <<-'EOF'\nlog4j.rootLogger=WARN, stdout\n\nlog4j.appender.stdout=org.apache.log4j.ConsoleAppender\nlog4j.appender.stdout.layout=org.apache.log4j.PatternLayout\nlog4j.appender.stdout.layout.ConversionPattern=[%d] %p %m (%c)%n\nlog4j.appender.stdout.Target=System.out\n\n# Ignore that we are using log4j as we aren't starting JMX anyway\nlog4j.logger.org.apache.cassandra.utils.logging=ERROR\n# Ignore that we cannot increase RLIMIT_MEMLOCK or run Cassandra as root\nlog4j.logger.org.apache.cassandra.utils.NativeLibrary=ERROR\n# Ignore that we disabled JMX and haven't installed jemalloc (not available on Alpine)\nlog4j.logger.org.apache.cassandra.service.StartupChecks=OFF\n# Ignore C* 3.x java.lang.NoSuchMethodError: 'sun.misc.Cleaner sun.nio.ch.DirectBuffer.cleaner()'\nlog4j.logger.org.apache.cassandra.io.util.FileUtils=OFF\n# Ignore warnings about less than 64GB disk\nlog4j.logger.org.apache.cassandra.config.DatabaseDescriptor=ERROR\nEOF\n\n# Take a backup so that we can safely mount an empty volume over the data directory and maintain the schema\ncp -R data/ data-backup/\n\necho \"*** Cleaning Up\"\nrm -rf zipkin-schemas/ temp_cassandra.out\n\necho \"*** Image build complete\"\n" }, { "path": "docker/test-images/zipkin-cassandra/start-cassandra", "content": "#!/bin/sh\n#\n# Copyright The OpenZipkin Authors\n# SPDX-License-Identifier: Apache-2.0\n#\n\n# ENTRYPOINT script that starts Cassandra\n#\n# This intentionally locates config using the current working directory, in order to consolidate\n# Dockerfile instructions to WORKDIR\nset -eu\n\n# Apply one-time deferred configuration that relies on ENV variables\n#\n# If the schema has been removed due to mounting, restore from our backup. see: install\nif [ ! -d data/zipkin2 ]; then\n cp -rf data-backup/* data/\nfi\n\nIP=\"$(hostname -i || echo '127.0.0.1')\"\nsed -i \"s/127.0.0.1/${IP}/g\" conf/cassandra.yaml\n\n# Replace the logging level\nsed -i \"s/log4j.rootLogger.*/log4j.rootLogger=${LOGGING_LEVEL}, stdout/\" conf/log4j.properties\n\n# Use agent to allow instrumentation of a lambda: CASSANDRA-16304\nJAMM_JAR=$(ls lib/jamm-*.jar)\n\n# Configure the Docker HEALTHCHECK\nexport HEALTHCHECK_IP=${IP}\nexport HEALTHCHECK_PORT=9042\nexport HEALTHCHECK_KIND=tcp\n\necho Starting Cassandra\n# -cp 'classes:lib/*' allows layers to patch the image without packaging or\n# overwriting jars.\n#\n# We also add exports and opens from both Cassandra v4 and v5, except for\n# attach, compiler and rmi because our JRE excludes these modules.\n#\n# Merging makes adding Cassandra v5 easier and lets us share a common JRE 17+\n# with other test images even if Cassandra v4 will never officially support it.\n# https://github.com/apache/cassandra/blob/cassandra-4.0.11/conf/jvm11-server.options\n# https://github.com/apache/cassandra/blob/cassandra-5.0/conf/jvm17-server.options\n#\n# Finally, we allow security manager to prevent JRE 21 crashing when Cassandra\n# attempts ThreadAwareSecurityManager.install()\nexec java -cp 'classes:lib/*' ${JAVA_OPTS} \\\n -Djava.security.manager=allow \\\n -Xbootclasspath/a:${JAMM_JAR} -javaagent:${JAMM_JAR} \\\n -Djdk.attach.allowAttachSelf=true \\\n --add-exports java.base/jdk.internal.misc=ALL-UNNAMED \\\n --add-exports java.base/jdk.internal.ref=ALL-UNNAMED \\\n --add-exports java.base/sun.nio.ch=ALL-UNNAMED \\\n --add-exports java.sql/java.sql=ALL-UNNAMED \\\n --add-exports java.base/java.lang.ref=ALL-UNNAMED \\\n --add-exports jdk.unsupported/sun.misc=ALL-UNNAMED \\\n --add-opens java.base/java.lang.module=ALL-UNNAMED \\\n --add-opens java.base/jdk.internal.loader=ALL-UNNAMED \\\n --add-opens java.base/jdk.internal.ref=ALL-UNNAMED \\\n --add-opens java.base/jdk.internal.reflect=ALL-UNNAMED \\\n --add-opens java.base/jdk.internal.math=ALL-UNNAMED \\\n --add-opens java.base/jdk.internal.module=ALL-UNNAMED \\\n --add-opens java.base/jdk.internal.util.jar=ALL-UNNAMED \\\n --add-opens jdk.management/com.sun.management.internal=ALL-UNNAMED \\\n --add-opens java.base/java.io=ALL-UNNAMED \\\n --add-opens java.base/java.nio=ALL-UNNAMED \\\n --add-opens java.base/sun.nio.ch=ALL-UNNAMED \\\n --add-opens java.base/java.io=ALL-UNNAMED \\\n --add-opens java.base/java.lang.reflect=ALL-UNNAMED \\\n --add-opens java.base/java.lang=ALL-UNNAMED \\\n --add-opens java.base/java.util=ALL-UNNAMED \\\n --add-opens java.base/java.nio=ALL-UNNAMED \\\n --add-opens java.base/java.util.concurrent=ALL-UNNAMED \\\n --add-opens java.base/java.util.concurrent.atomic=ALL-UNNAMED \\\n -Djava.io.tmpdir=/tmp \\\n -Dcassandra-foreground=yes \\\n -Dcassandra.storagedir=${PWD} \\\n -Dcassandra.triggers_dir=${PWD}/triggers \\\n -Dcassandra.config=file:${PWD}/conf/cassandra.yaml \\\n -Dlog4j.configuration=file:${PWD}/conf/log4j.properties \\\n org.apache.cassandra.service.CassandraDaemon \"$@\"\n" }, { "path": "docker/test-images/zipkin-elasticsearch7/Dockerfile", "content": "#\n# Copyright The OpenZipkin Authors\n# SPDX-License-Identifier: Apache-2.0\n#\n\n# java_version is used for install and runtime layers of zipkin-elasticsearch7\n#\n# Use latest version here: https://github.com/orgs/openzipkin/packages/container/package/java\n# This is defined in many places because Docker has no \"env\" script functionality unless you use\n# docker-compose: When updating, update everywhere.\nARG java_version=21.0.7_p6\n\n# We copy files from the context into a scratch container first to avoid a problem where docker and\n# docker compose don't share layer hashes https://github.com/docker/compose/issues/883 normally.\n# COPY --from= works around the issue.\nFROM scratch as scratch\n\nCOPY build-bin/docker/docker-healthcheck /docker-bin/\nCOPY docker/test-images/zipkin-elasticsearch7/start-elasticsearch /docker-bin/\nCOPY docker/test-images/zipkin-elasticsearch7/config/ /config/\n\nFROM ghcr.io/openzipkin/java:${java_version} as install\n\nWORKDIR /install\n\n# Use latest 7.x version from https://www.elastic.co/downloads/past-releases#elasticsearch-no-jdk\n# This is defined in many places because Docker has no \"env\" script functionality unless you use\n# docker-compose: When updating, update everywhere.\nARG elasticsearch7_version=7.17.27\n\n# Download only the OSS distribution (lacks X-Pack)\nRUN \\\n# Connection resets are frequent in GitHub Actions workflows \\\nwget --random-wait --tries=5 -qO- \\\n# We don't download bin scripts as we customize for reasons including BusyBox problems\nhttps://artifacts.elastic.co/downloads/elasticsearch/elasticsearch-${elasticsearch7_version}-no-jdk-linux-x86_64.tar.gz| tar xz \\\n --wildcards --strip=1 --exclude=*/bin && mkdir classes\nCOPY --from=scratch /config/ ./config/\n\n# Use a full Java distribution rather than adding test modules to the\n# production -jre base layer used by zipkin and zipkin-slim.\nFROM ghcr.io/openzipkin/java:${java_version} as zipkin-elasticsearch7\nLABEL org.opencontainers.image.description=\"Elasticsearch distribution on OpenJDK and Alpine Linux\"\nARG elasticsearch7_version=7.17.27\nLABEL elasticsearch-version=$elasticsearch7_version\n\n# The full license is also included in the image at /elasticsearch/LICENSE.txt.\nLABEL org.opencontainers.image.licenses=\"Elastic-License-2.0\"\n\n# Add HEALTHCHECK and ENTRYPOINT scripts into the default search path\nCOPY --from=scratch /docker-bin/* /usr/local/bin/\n# We use start period of 30s to avoid marking the container unhealthy on slow or contended CI hosts\nHEALTHCHECK --interval=1s --start-period=30s --timeout=5s CMD [\"docker-healthcheck\"]\nENTRYPOINT [\"start-elasticsearch\"]\n\n# All content including binaries and logs write under WORKDIR\nARG USER=elasticsearch\nWORKDIR /${USER}\n\n# Ensure the process doesn't run as root\nRUN adduser -g '' -h ${PWD} -D ${USER}\nUSER ${USER}\n\n# Copy binaries and config we installed earlier\nCOPY --from=install --chown=${USER} /install .\n\n# Use to set heap, trust store or other system properties.\nENV JAVA_OPTS=\"-Xms512m -Xmx512m -XX:+ExitOnOutOfMemoryError\"\nENV LIBFFI_TMPDIR=/tmp\nEXPOSE 9200\n" }, { "path": "docker/test-images/zipkin-elasticsearch7/README.md", "content": "## zipkin-elasticsearch7 Docker image\n\nThe `zipkin-elasticsearch7` testing image runs Elasticsearch 7.x for [Elasticsearch storage](../../../zipkin-storage/elasticsearch)\nintegration.\n\nTo build `openzipkin/zipkin-elasticsearch7:test`, from the top-level of the repository, run:\n```bash\n$ DOCKER_FILE=docker/test-images/zipkin-elasticsearch7/Dockerfile build-bin/docker/docker_build openzipkin/zipkin-elasticsearch7:test\n```\n\nYou can use the env variable `JAVA_OPTS` to change settings such as heap size for Elasticsearch.\n\n#### Host setup\n\nElasticsearch is [strict](https://github.com/docker-library/docs/tree/master/elasticsearch#host-setup)\nabout virtual memory. You will need to adjust accordingly (especially if you notice Elasticsearch crash!)\n\n```bash\n# If docker is running on your host machine, adjust the kernel setting directly\n$ sudo sysctl -w vm.max_map_count=262144\n\n# If using docker-machine/Docker Toolbox/Boot2Docker, remotely adjust the same\n$ docker-machine ssh default \"sudo sysctl -w vm.max_map_count=262144\"\n\n# If using colima, it is similar as well\n$ colima ssh \"sudo sysctl -w vm.max_map_count=262144\"\n```\n\n#### License\n\nThis Elasticsearch image is only made for testing features supported by Zipkin,\nand is subject to [Elastic-License-2.0](https://www.elastic.co/licensing/elastic-license).\nFor more details, inspect the LICENSE.txt and NOTICE.txt in the /elasticsearch\ndirectory of this image.\n" }, { "path": "docker/test-images/zipkin-elasticsearch7/config/elasticsearch.yml", "content": "#\n# Copyright The OpenZipkin Authors\n# SPDX-License-Identifier: Apache-2.0\n#\n\ncluster.name: \"docker-cluster\"\nnetwork.host: 0.0.0.0\nnode.name: zipkin-elasticsearch\n\n# Enable development mode and disable bootstrap checks\n# See https://www.elastic.co/guide/en/elasticsearch/reference/current/bootstrap-checks.html\ndiscovery.type: single-node\n# Avoid deprecation errors: as of 8.x the only accepted value is true.\ncluster.routing.allocation.disk.watermark.enable_for_single_data_node: true\n\n# This is a test image, so we are not afraid to delete all indices. Avoids:\n# Wildcard expressions or all indices are not allowed\naction.destructive_requires_name: false\n# We don't use geoip\ningest.geoip.downloader.enabled: false\n\n# disable all xpack features than can be disabled\nxpack.graph.enabled: false\nxpack.ml.enabled: false\nxpack.security.enabled: false\nxpack.watcher.enabled: false\n" }, { "path": "docker/test-images/zipkin-elasticsearch7/config/log4j2.properties", "content": "#\n# Copyright The OpenZipkin Authors\n# SPDX-License-Identifier: Apache-2.0\n#\n\nstatus = error\n\nappender.console.type = Console\nappender.console.name = console\nappender.console.layout.type = PatternLayout\nappender.console.layout.pattern = [%d{ISO8601}][%-5p][%-25c{1.}] [%node_name]%marker %m%n\n\nrootLogger.level = info\nrootLogger.appenderRef.console.ref = console\n\n# unsolved https://github.com/sherifabdlnaby/elastdocker/issues/108\nlogger.aws.name = com.amazonaws.auth.profile.internal.BasicProfileConfigFileLoader\nlogger.aws.level = error\n" }, { "path": "docker/test-images/zipkin-elasticsearch7/start-elasticsearch", "content": "#!/bin/sh\n#\n# Copyright The OpenZipkin Authors\n# SPDX-License-Identifier: Apache-2.0\n#\n\n# ENTRYPOINT script that starts Elasticsearch\n#\n# This intentionally locates config using the current working directory, in order to consolidate\n# Dockerfile instructions to WORKDIR\nset -eu\n\n# This file inlines what's done by the Elasticsearch script machinery, which doesn't work here due\n# to our images using busybox (not bash). See #3044\n#\n# Notable settings:\n# * lower heap size\n# * tmpdir manual as https://github.com/elastic/elasticsearch/pull/31003 was closed won't fix\n# * disable log4j JMX not just because we don't use it...\n# * ES enables security manager https://github.com/elastic/elasticsearch/issues/21932#issuecomment-264435034\n\n# Configure the Docker HEALTHCHECK\nexport HEALTHCHECK_PORT=9200\nexport HEALTHCHECK_PATH=/_cluster/health\n\n# -cp 'classes:lib/*' allows layers to patch the image without packaging or overwriting jars\n# We allow security manager (via flag to prevent JRE 21 crash) as Elasticsearch.main needs it.\nexec java -cp 'classes:lib/*' ${JAVA_OPTS} \\\n -Djava.security.manager=allow \\\n -Djava.io.tmpdir=/tmp \\\n -Dlog4j2.disable.jmx=true \\\n -Des.path.home=$PWD -Des.path.conf=$PWD/config \\\n org.elasticsearch.bootstrap.Elasticsearch \"$@\"\n" }, { "path": "docker/test-images/zipkin-elasticsearch8/Dockerfile", "content": "#\n# Copyright The OpenZipkin Authors\n# SPDX-License-Identifier: Apache-2.0\n#\n\n# java_version is used for install and runtime layers of zipkin-elasticsearch8\n#\n# Use latest version here: https://github.com/orgs/openzipkin/packages/container/package/java\n# This is defined in many places because Docker has no \"env\" script functionality unless you use\n# docker-compose: When updating, update everywhere.\nARG java_version=21.0.7_p6\n\n# We copy files from the context into a scratch container first to avoid a problem where docker and\n# docker compose don't share layer hashes https://github.com/docker/compose/issues/883 normally.\n# COPY --from= works around the issue.\nFROM scratch as scratch\n\nCOPY build-bin/docker/docker-healthcheck /docker-bin/\nCOPY docker/test-images/zipkin-elasticsearch8/start-elasticsearch /docker-bin/\nCOPY docker/test-images/zipkin-elasticsearch7/config/ /config/\n\nFROM ghcr.io/openzipkin/java:${java_version} as install\n\nWORKDIR /install\n\n# Use latest 8.x version from https://www.elastic.co/downloads/past-releases#elasticsearch\n# This is defined in many places because Docker has no \"env\" script functionality unless you use\n# docker-compose: When updating, update everywhere.\nARG elasticsearch8_version=8.17.2\n\n# Download only the OSS distribution (lacks X-Pack)\nRUN \\\n# Connection resets are frequent in GitHub Actions workflows \\\nwget --random-wait --tries=5 -qO- \\\n# We don't download bin scripts as we customize for reasons including BusyBox problems\nhttps://artifacts.elastic.co/downloads/elasticsearch/elasticsearch-${elasticsearch8_version}-linux-x86_64.tar.gz| tar xz \\\n --wildcards --strip=1 --exclude=jdk --exclude=*/bin\nCOPY --from=scratch /config/ ./config/\n\n# Use a full Java distribution rather than adding test modules to the\n# production -jre base layer used by zipkin and zipkin-slim.\nFROM ghcr.io/openzipkin/java:${java_version} as zipkin-elasticsearch8\nLABEL org.opencontainers.image.description=\"Elasticsearch distribution on OpenJDK and Alpine Linux\"\nARG elasticsearch8_version=8.17.2\nLABEL elasticsearch-version=$elasticsearch8_version\n\n# The full license is also included in the image at /elasticsearch/LICENSE.txt.\nLABEL org.opencontainers.image.licenses=\"Elastic-License-2.0\"\n\n# Add HEALTHCHECK and ENTRYPOINT scripts into the default search path\nCOPY --from=scratch /docker-bin/* /usr/local/bin/\n# We use start period of 30s to avoid marking the container unhealthy on slow or contended CI hosts\nHEALTHCHECK --interval=1s --start-period=30s --timeout=5s CMD [\"docker-healthcheck\"]\nENTRYPOINT [\"start-elasticsearch\"]\n\n# All content including binaries and logs write under WORKDIR\nARG USER=elasticsearch\nWORKDIR /${USER}\n\n# Ensure the process doesn't run as root\nRUN adduser -g '' -h ${PWD} -D ${USER}\nUSER ${USER}\n\n# Copy binaries and config we installed earlier\nCOPY --from=install --chown=${USER} /install .\n\n# Use to set heap, trust store or other system properties.\nENV ES_JAVA_OPTS=\"-Xms512m -Xmx512m -XX:+ExitOnOutOfMemoryError\"\nENV LIBFFI_TMPDIR=/tmp\nEXPOSE 9200\n" }, { "path": "docker/test-images/zipkin-elasticsearch8/README.md", "content": "## zipkin-elasticsearch8 Docker image\n\nThe `zipkin-elasticsearch8` testing image runs Elasticsearch 8.x for [Elasticsearch storage](../../../zipkin-storage/elasticsearch)\nintegration.\n\nTo build `openzipkin/zipkin-elasticsearch8:test`, from the top-level of the repository, run:\n```bash\n$ DOCKER_FILE=docker/test-images/zipkin-elasticsearch8/Dockerfile build-bin/docker/docker_build openzipkin/zipkin-elasticsearch8:test\n```\n\nYou can use the env variable `ES_JAVA_OPTS` to change settings such as heap size for Elasticsearch.\n\n#### Host setup\n\nElasticsearch is [strict](https://github.com/docker-library/docs/tree/master/elasticsearch#host-setup)\nabout virtual memory. You will need to adjust accordingly (especially if you notice Elasticsearch crash!)\n\n```bash\n# If docker is running on your host machine, adjust the kernel setting directly\n$ sudo sysctl -w vm.max_map_count=262144\n\n# If using docker-machine/Docker Toolbox/Boot2Docker, remotely adjust the same\n$ docker-machine ssh default \"sudo sysctl -w vm.max_map_count=262144\"\n\n# If using colima, it is similar as well\n$ colima ssh \"sudo sysctl -w vm.max_map_count=262144\"\n```\n\n#### License\n\nThis Elasticsearch image is only made for testing features supported by Zipkin,\nand is subject to [Elastic-License-2.0](https://www.elastic.co/licensing/elastic-license).\nFor more details, inspect the LICENSE.txt and NOTICE.txt in the /elasticsearch\ndirectory of this image.\n" }, { "path": "docker/test-images/zipkin-elasticsearch8/start-elasticsearch", "content": "#!/bin/sh\n#\n# Copyright The OpenZipkin Authors\n# SPDX-License-Identifier: Apache-2.0\n#\n\n# ENTRYPOINT script that starts Elasticsearch\n#\n# This intentionally locates config using the current working directory, in order to consolidate\n# Dockerfile instructions to WORKDIR\nset -eu\n\n# Configure the Docker HEALTHCHECK\nexport HEALTHCHECK_PORT=9200\nexport HEALTHCHECK_PATH=/_cluster/health\n\n# This loads the ES launcher because configuration of the actual process is\n# in binary and not documented for external use.\n# See https://github.com/elastic/elasticsearch/blob/v8.11.3/server/src/main/java/org/elasticsearch/bootstrap/ServerArgs.java#L57\n#\n# Notably, this means that just like the default image, the ES daemon is not\n# pid 1\nexec java -cp 'lib/*:lib/cli-launcher/*' -XX:+UseSerialGC \\\n -Dcli.name=server \\\n -Dcli.script=$PWD/bin/elasticsearch \\\n -Dcli.libs=lib/tools/server-cli \\\n -Des.path.home=$PWD \\\n -Des.path.conf=$PWD/config \\\n -Des.distribution.type=docker \\\n org.elasticsearch.launcher.CliToolLauncher\n" }, { "path": "docker/test-images/zipkin-eureka/Dockerfile", "content": "#\n# Copyright The OpenZipkin Authors\n# SPDX-License-Identifier: Apache-2.0\n#\n\n# java_version is used for install and runtime base layers of eureka and eureka-slim.\n#\n# Use latest version here: https://github.com/orgs/openeureka/packages/container/package/java\n# This is defined in many places because Docker has no \"env\" script functionality unless you use\n# docker-compose: When updating, update everywhere.\nARG java_version=21.0.7_p6\n\n# We copy files from the context into a scratch container first to avoid a problem where docker and\n# docker compose don't share layer hashes https://github.com/docker/compose/issues/883 normally.\n# COPY --from= works around the issue.\nFROM scratch as scratch\n\nCOPY build-bin/docker/docker-healthcheck /docker-bin/\nCOPY docker/test-images/zipkin-eureka/start-eureka /docker-bin/\n\n# We needsource because as of Eureka 2.0, there is no distribution in the\n# source repository anymore, and the war isn't functional either. The current\n# approach is to build your own with Spring Cloud.\n#\n# See https://github.com/Netflix/eureka/releases/tag/v2.0.0\nCOPY build-bin/maven /code/\nCOPY docker/test-images/zipkin-eureka /code/\n\n# This version is only used during the install process. Try to be consistent as it reduces layers,\n# which reduces downloads.\nFROM ghcr.io/openzipkin/java:${java_version} as install\n\nWORKDIR /code\nCOPY --from=scratch /code/ .\n\n# Build the custom Eureka server\nRUN /code/maven_build && \\\n mvn -q --batch-mode -DoutputDirectory=/install/lib dependency:copy-dependencies && \\\n cp -r target/classes /install/\n\n# Use a full Java distribution rather than adding test modules to the\n# production -jre base layer used by zipkin and zipkin-slim.\n#\n# Specifically, this is about NoClassDefFoundError: org/ietf/jgss/GSSException\nFROM ghcr.io/openzipkin/java:${java_version} as zipkin-eureka\nLABEL org.opencontainers.image.description=\"Eureka on OpenJDK and Alpine Linux\"\n\n# All content including binaries and logs write under WORKDIR\nARG USER=eureka\nWORKDIR /${USER}\n\n# Ensure the process doesn't run as root\nRUN adduser -g '' -h ${PWD} -D ${USER}\n\n# Add HEALTHCHECK and ENTRYPOINT scripts into the default search path\nCOPY --from=scratch /docker-bin/* /usr/local/bin/\n\n# Copy binaries and config we installed earlier\nCOPY --from=install --chown=${USER} /install .\n\n# We use start period of 30s to avoid marking the container unhealthy on slow or contended CI hosts\nHEALTHCHECK --interval=1s --start-period=30s --timeout=5s CMD [\"docker-healthcheck\"]\nENV HEALTHCHECK_PATH=/actuator/health\nENV HEALTHCHECK_PORT=8761\n\nENTRYPOINT [\"start-eureka\"]\n\n# Switch to the runtime user\nUSER ${USER}\n\n# Use to set heap, trust store or other system properties.\nENV JAVA_OPTS=\"-Xms64m -Xmx64m -XX:+ExitOnOutOfMemoryError\"\nEXPOSE 8761\n" }, { "path": "docker/test-images/zipkin-eureka/README.md", "content": "## zipkin-eureka Docker image\n\nThe `zipkin-eureka` testing image runs Eureka Server for service discovery\nintegration of the Zipkin server. This listens on port 8761.\n\nBesides norms defined in [docker-java](https://github.com/openzipkin/docker-java), this accepts the\nfollowing environment variables:\n\n* `EUREKA_USERNAME`: username for authenticating endpoints under \"/eureka\".\n* `EUREKA_PASSWORD`: password for authenticating endpoints under \"/eureka\".\n* `JAVA_OPTS`: to change settings such as heap size for Eureka.\n\nTo build `openzipkin/zipkin-eureka:test`, from the top-level of the repository, run:\n```bash\n$ DOCKER_FILE=docker/test-images/zipkin-eureka/Dockerfile build-bin/docker/docker_build openzipkin/zipkin-eureka:test\n$ docker run -p 8761:8761 --rm openzipkin/zipkin-eureka:test\n```\n" }, { "path": "docker/test-images/zipkin-eureka/pom.xml", "content": "\n\n 4.0.0\n\n io.zipkin.test\n eureka\n 1.0-SNAPSHOT\n jar\n\n Netflix Eureka test binary\n Netflix Eureka test binary\n\n \n 17\n 17\n 17\n \n\n \n \n \n \n com.fasterxml.jackson\n jackson-bom\n 2.21.1\n pom\n import\n \n \n org.springframework.boot\n spring-boot-dependencies\n 3.5.11\n pom\n import\n \n \n \n com.google.guava\n guava\n 33.4.0-jre\n \n \n com.thoughtworks.xstream\n xstream\n 1.4.21\n \n \n org.apache.httpcomponents\n httpclient\n 4.5.14\n \n \n \n\n \n \n org.springframework.cloud\n spring-cloud-starter-netflix-eureka-server\n 4.3.1\n \n \n \n commons-logging\n commons-logging\n \n \n software.amazon.ion\n ion-java\n \n \n \n \n \n com.amazon.ion\n ion-java\n 1.11.10\n \n\n \n \n org.springframework.boot\n spring-boot-starter-cache\n \n \n com.github.ben-manes.caffeine\n caffeine\n \n \n\n" }, { "path": "docker/test-images/zipkin-eureka/src/main/java/zipkin/test/EurekaProperties.java", "content": "/*\n * Copyright The OpenZipkin Authors\n * SPDX-License-Identifier: Apache-2.0\n */\npackage zipkin.test;\n\nimport org.springframework.boot.context.properties.ConfigurationProperties;\n\n/** Properties for configuring and building a {@link EurekaServer}. */\n@ConfigurationProperties(\"eureka\")\nclass EurekaProperties {\n\n /** Optional username to require. */\n private String username;\n\n /** Optional password to require. */\n private String password;\n\n public String getUsername() {\n return username;\n }\n\n public void setUsername(String username) {\n this.username = username;\n }\n\n public String getPassword() {\n return password;\n }\n\n public void setPassword(String password) {\n this.password = password;\n }\n}\n" }, { "path": "docker/test-images/zipkin-eureka/src/main/java/zipkin/test/EurekaSecurity.java", "content": "/*\n * Copyright The OpenZipkin Authors\n * SPDX-License-Identifier: Apache-2.0\n */\npackage zipkin.test;\n\nimport jakarta.servlet.FilterChain;\nimport jakarta.servlet.ServletException;\nimport jakarta.servlet.http.HttpServletRequest;\nimport jakarta.servlet.http.HttpServletResponse;\nimport java.io.IOException;\nimport java.util.Base64;\nimport org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;\nimport org.springframework.boot.context.properties.EnableConfigurationProperties;\nimport org.springframework.boot.web.servlet.FilterRegistrationBean;\nimport org.springframework.context.annotation.Bean;\nimport org.springframework.context.annotation.Configuration;\nimport org.springframework.web.filter.OncePerRequestFilter;\n\nimport static java.nio.charset.StandardCharsets.UTF_8;\n\n/** This enables security, particularly only BASIC auth, when {@code EUREKA_USERNAME} is set. */\n@Configuration\n@ConditionalOnProperty(\"eureka.username\")\n@EnableConfigurationProperties(EurekaProperties.class)\npublic class EurekaSecurity {\n @Bean FilterRegistrationBean authFilter(EurekaProperties props) {\n FilterRegistrationBean registrationBean = new FilterRegistrationBean<>();\n registrationBean.setFilter(new BasicAuthFilter(props.getUsername(), props.getPassword()));\n registrationBean.addUrlPatterns(\"/eureka/*\"); // Auth /eureka, though only v2 is valid\n registrationBean.setOrder(2);\n return registrationBean;\n }\n\n /** Implements BASIC instead of spring-security + CORS, CSRF and management exclusions. */\n static final class BasicAuthFilter extends OncePerRequestFilter {\n final String expectedAuthorization;\n\n BasicAuthFilter(String username, String password) {\n expectedAuthorization =\n \"Basic \" + Base64.getEncoder().encodeToString((username + ':' + password).getBytes(UTF_8));\n }\n\n @Override protected void doFilterInternal(HttpServletRequest req, HttpServletResponse res,\n FilterChain chain) throws ServletException, IOException {\n String authHeader = req.getHeader(\"Authorization\");\n if (expectedAuthorization.equals(authHeader)) {\n chain.doFilter(req, res); // Pass on the supplied credentials\n return;\n }\n res.setHeader(\"WWW-Authenticate\", \"Basic realm=\\\"Realm'\\\"\");\n res.sendError(HttpServletResponse.SC_UNAUTHORIZED); // Return 401 otherwise.\n }\n }\n}\n" }, { "path": "docker/test-images/zipkin-eureka/src/main/java/zipkin/test/EurekaServer.java", "content": "/*\n * Copyright The OpenZipkin Authors\n * SPDX-License-Identifier: Apache-2.0\n */\npackage zipkin.test;\n\nimport org.springframework.boot.SpringApplication;\nimport org.springframework.boot.actuate.autoconfigure.security.servlet.ManagementWebSecurityAutoConfiguration;\nimport org.springframework.boot.autoconfigure.SpringBootApplication;\nimport org.springframework.boot.autoconfigure.security.servlet.SecurityAutoConfiguration;\nimport org.springframework.cloud.netflix.eureka.server.EnableEurekaServer;\nimport org.springframework.context.annotation.Import;\n\n/**\n * This disables automatic security configuration, deferring to {@linkplain EurekaSecurity}.\n * Doing so allows Eureka to start as if spring-security wasn't in the classpath.\n */\n@SpringBootApplication(\n exclude = {SecurityAutoConfiguration.class, ManagementWebSecurityAutoConfiguration.class}\n)\n@EnableEurekaServer\n@Import(EurekaSecurity.class)\npublic class EurekaServer {\n\n public static void main(String[] args) {\n SpringApplication.run(EurekaServer.class, args);\n }\n}\n" }, { "path": "docker/test-images/zipkin-eureka/src/main/resources/application.yaml", "content": "#\n# Copyright The OpenZipkin Authors\n# SPDX-License-Identifier: Apache-2.0\n#\n\n# Add configuration to disable as much server caching as possible. Note that\n# not all configuration here are defined by netflix/eureka, rather some are\n# specific to spring-cloud/spring-cloud-netflix.\neureka:\n client:\n registerWithEureka: false\n fetchRegistry: false # in netflix/eureka this is shouldFetchRegistry\n registryFetchIntervalSeconds: 1\n server:\n useReadOnlyResponseCache: false\n # We could set myUrl to avoid this server thinking it is also an\n # unavailable replica. However, the effect of doing so is worse.\n # See https://github.com/spring-cloud/spring-cloud-netflix/issues/4251\nserver:\n port: 8761\nspring:\n jmx:\n # reduce startup time by excluding unexposed JMX service\n enabled: false\n main:\n banner-mode: \"off\"\n profiles:\n active: \"default\"\nlogging:\n level:\n # reduce chattiness\n root: 'WARN'\n # hush initialization warnings from BeanPostProcessorChecker\n org.springframework.context.support: 'OFF'\n # show startup completion\n zipkin.test.EurekaServer: 'INFO'\n" }, { "path": "docker/test-images/zipkin-eureka/start-eureka", "content": "#!/bin/sh\n#\n# Copyright The OpenZipkin Authors\n# SPDX-License-Identifier: Apache-2.0\n#\n\n# ENTRYPOINT script that starts Eureka\nset -eu\n\nexec java -cp 'classes:lib/*' ${JAVA_OPTS} zipkin.test.EurekaServer \"$@\"\n" }, { "path": "docker/test-images/zipkin-kafka/Dockerfile", "content": "#\n# Copyright The OpenZipkin Authors\n# SPDX-License-Identifier: Apache-2.0\n#\n\n# java_version is used for install and runtime layers of zipkin-kafka\n#\n# Use latest version here: https://github.com/orgs/openzipkin/packages/container/package/java\n# This is defined in many places because Docker has no \"env\" script functionality unless you use\n# docker-compose: When updating, update everywhere.\nARG java_version=21.0.7_p6\n\n# We copy files from the context into a scratch container first to avoid a problem where docker and\n# docker compose don't share layer hashes https://github.com/docker/compose/issues/883 normally.\n# COPY --from= works around the issue.\nFROM scratch as scratch\n\nCOPY build-bin/docker/docker-healthcheck /docker-bin/\nCOPY docker/test-images/zipkin-kafka/start-kafka-zookeeper /docker-bin/\nCOPY docker/test-images/zipkin-kafka/install.sh /install/\n\nFROM ghcr.io/openzipkin/java:${java_version} as install\n\n# Use latest release from: https://kafka.apache.org/downloads\n#\n# This is defined in many places because Docker has no \"env\" script functionality unless you use\n# docker-compose: When updating, update everywhere.\nARG kafka_version=3.9.1\nENV KAFKA_VERSION=$kafka_version\n# Note: Scala 2.13+ supports JRE 14\nARG scala_version=2.13\nENV SCALA_VERSION=$scala_version\n\nWORKDIR /install\nCOPY --from=scratch /install/install.sh /tmp/\nRUN /tmp/install.sh && rm /tmp/install.sh\n\n# Share the same base image to reduce layers used in testing\nFROM ghcr.io/openzipkin/java:${java_version}-jre as zipkin-kafka\nLABEL org.opencontainers.image.description=\"Kafka and ZooKeeper on OpenJDK and Alpine Linux\"\nARG kafka_version=3.9.0\nLABEL kafka-version=$kafka_version\n\n# Add HEALTHCHECK and ENTRYPOINT scripts into the default search path\nCOPY --from=scratch /docker-bin/* /usr/local/bin/\n# We use start period of 30s to avoid marking the container unhealthy on slow or contended CI hosts\nHEALTHCHECK --interval=1s --start-period=30s --timeout=5s CMD [\"docker-healthcheck\"]\nENTRYPOINT [\"start-kafka-zookeeper\"]\n\n# All content including binaries and logs write under WORKDIR\nARG USER=kafka\nWORKDIR /${USER}\n\n# Ensure the process doesn't run as root\nRUN adduser -g '' -h ${PWD} -D ${USER}\nUSER ${USER}\n\n# Copy binaries and config we installed earlier\nCOPY --from=install --chown=${USER} /install .\n\n# ${KAFKA_ADVERTISED_HOST_NAME}:19092 is for connections from the Docker host\nENV KAFKA_ADVERTISED_HOST_NAME=localhost\n# Use to set heap, trust store or other system properties.\nENV ZOOKEEPER_JAVA_OPTS=\"-Xms32m -Xmx32m -XX:+ExitOnOutOfMemoryError\"\nENV JAVA_OPTS=\"-Xms256m -Xmx256m -XX:+ExitOnOutOfMemoryError\"\nENV LOGGING_LEVEL=WARN\n\nEXPOSE 2181 9092 19092\n" }, { "path": "docker/test-images/zipkin-kafka/README.md", "content": "## zipkin-kafka Docker image\n\nThe `zipkin-kafka` testing image runs both Kafka+ZooKeeper for the [Kafka collector](../../../zipkin-collector/kafka)\nand the upcoming [Kafka storage](https://github.com/openzipkin-contrib/zipkin-storage-kafka).\n\nBesides norms defined in [docker-java](https://github.com/openzipkin/docker-java), this accepts the\nfollowing environment variables:\n\n * `LOGGING_LEVEL`: Root Log4J logging level sent to stdout. Defaults to \"WARN\"\n\n\nTo build `openzipkin/zipkin-kafka:test`, from the top-level of the repository, run:\n```bash\n$ DOCKER_FILE=docker/test-images/zipkin-kafka/Dockerfile build-bin/docker/docker_build openzipkin/zipkin-kafka:test\n```\n\nThen configure the [Kafka sender](https://github.com/openzipkin/zipkin-reporter-java/blob/master/kafka/src/main/java/zipkin2/reporter/kafka/KafkaSender.java) using a `bootstrapServers` value of `host.docker.internal:9092` if your application is inside the same docker network or `localhost:19092` if not, but running on the same host.\n\nIn other words, if you are running a sample application on your laptop, you would use `localhost:19092` bootstrap server to send spans to the Kafka broker running in Docker.\n" }, { "path": "docker/test-images/zipkin-kafka/install.sh", "content": "#!/bin/sh\n#\n# Copyright The OpenZipkin Authors\n# SPDX-License-Identifier: Apache-2.0\n#\n\n# install script used only in building the docker image, but not at runtime.\n# This uses relative path so that you can change the home dir without editing this file.\n# This also trims dependencies to only those used at runtime.\nset -eux\n\necho \"*** Installing Kafka and dependencies\"\n# Create directories for the Java classpath\nmkdir classes lib\n\n# Dist includes large dependencies needed by streams and connect: retain only broker and ZK.\n# We can do this because broker is independent from both kafka-streams and connect modules.\n# See KAFKA-10380\n#\n# TODO: MDEP-723 if addressed can remove the pom.xml here\ncat > pom.xml <<-'EOF'\n\n 4.0.0\n\n io.zipkin.kafka\n get-kafka\n 0.1.0-SNAPSHOT\n pom\n\n \n \n org.apache.kafka\n kafka_${scala.version}\n ${kafka.version}\n \n \n org.slf4j\n slf4j-log4j12\n 1.7.36\n \n \n\nEOF\nmvn -q --batch-mode -DoutputDirectory=lib \\\n -Dscala.version=${SCALA_VERSION} -Dkafka.version=${KAFKA_VERSION} \\\n org.apache.maven.plugins:maven-dependency-plugin:3.8.1:copy-dependencies\nrm pom.xml\n\n# Make sure you use relative paths in references like this, so that installation\n# is decoupled from runtime\nmkdir -p bin config data/kafka data/zookeeper\n\n# Make a basic log4j config which only logs warnings (to stdout)\n#\n# NOTE: Two unavoidable log WARN messages remain:\n# 1. Either no config or no quorum defined in config, running in standalone mode (org.apache.zookeeper.server.quorum.QuorumPeerMain)\n# * https://github.com/apache/zookeeper/blob/e91455c1e3c50405666cd8afad71d99dceb7b340/zookeeper-server/src/main/java/org/apache/zookeeper/server/quorum/QuorumPeerMain.java#L138-L140\n# 2. No meta.properties file under dir /kafka/./data/kafka/meta.properties (kafka.server.BrokerMetadataCheckpoint)\n# * meta.properties file is generated when broker joins the cluster, using an auto-generated cluster id:\ncat > config/log4j.properties <<-'EOF'\nlog4j.rootLogger=WARN, stdout\n\nlog4j.appender.stdout=org.apache.log4j.ConsoleAppender\nlog4j.appender.stdout.layout=org.apache.log4j.PatternLayout\nlog4j.appender.stdout.layout.ConversionPattern=[%d] %p %m (%c)%n\nlog4j.appender.stdout.Target=System.out\nEOF\n\n# Set explicit, basic configuration\ncat > config/zookeeper.properties <<-'EOF'\ndataDir=./data/zookeeper\nclientPort=2181\nmaxClientCnxns=0\nadmin.enableServer=false\n# allow ruok command for testing ZK health\n4lw.commands.whitelist=srvr,ruok\nadmin.enableServer=false\nEOF\n\ncat > config/server.properties <<-'EOF'\nbroker.id=0\nzookeeper.connect=127.0.0.1:2181\nreplica.socket.timeout.ms=1500\n# log.dirs is about Kafka's data not Log4J\nlog.dirs=./data/kafka\nauto.create.topics.enable=true\noffsets.topic.replication.factor=1\nlisteners=PLAINTEXT://0.0.0.0:9092,PLAINTEXT_HOST://0.0.0.0:19092\nlistener.security.protocol.map=PLAINTEXT:PLAINTEXT,PLAINTEXT_HOST:PLAINTEXT\nEOF\n\n# Make a basic script for launching Kafka commands\ncat > bin/kafka-run-class.sh <<-'EOF'\n#!/bin/sh\nset -eu\n# classes allows layers to patch the image without packaging or overwriting jars\nexec java -cp 'classes:lib/*' ${JAVA_OPTS} \\\n -Djava.io.tmpdir=/tmp \\\n -Dlog4j.configuration=file:./config/log4j.properties \\\n \"$@\"\nEOF\nchmod 755 bin/kafka-run-class.sh\n\necho \"*** Image build complete\"\n" }, { "path": "docker/test-images/zipkin-kafka/start-kafka-zookeeper", "content": "#!/bin/sh\n#\n# Copyright The OpenZipkin Authors\n# SPDX-License-Identifier: Apache-2.0\n#\n\n# ENTRYPOINT script that starts ZooKeeper and then Kafka\n#\n# This intentionally locates config using the current working directory, in order to consolidate\n# Dockerfile instructions to WORKDIR\nset -eu\n\n# Apply one-time deferred configuration that relies on ENV variables\n#\n# Internal docker producers and consumers use the normal hostname:9092, and outside docker the advertised host on port 19092\nADVERTISED_LISTENERS=\"advertised.listeners=PLAINTEXT://${HOSTNAME}:9092,PLAINTEXT_HOST://${KAFKA_ADVERTISED_HOST_NAME}:19092\"\nKAFKA_CONFIG=./config/server.properties\ngrep -qF -- \"$ADVERTISED_LISTENERS\" $KAFKA_CONFIG || echo \"$ADVERTISED_LISTENERS\" >> $KAFKA_CONFIG\n\n# Replace the logging level\nsed -i \"s/log4j.rootLogger.*/log4j.rootLogger=${LOGGING_LEVEL}, stdout/\" config/log4j.properties\n\necho Starting ZooKeeper\n# -cp 'classes:lib/*' allows layers to patch the image without packaging or overwriting jars\nexec java -cp 'classes:lib/*' ${ZOOKEEPER_JAVA_OPTS} \\\n -Djava.io.tmpdir=/tmp \\\n -Dzookeeper.jmx.log4j.disable=true \\\n -Dlog4j.configuration=file:./config/log4j.properties \\\n org.apache.zookeeper.server.quorum.QuorumPeerMain ./config/zookeeper.properties &\n\n# Wait for ZooKeeper to be ok\nuntil echo ruok | nc 127.0.0.1 2181 > /dev/null; do sleep 1; done\n\n# Configure the Docker HEALTHCHECK\nexport HEALTHCHECK_PORT=9092\nexport HEALTHCHECK_KIND=tcp\n\necho Starting Kafka\nexec bin/kafka-run-class.sh kafka.Kafka ./config/server.properties \"$@\"\n" }, { "path": "docker/test-images/zipkin-mysql/Dockerfile", "content": "#\n# Copyright The OpenZipkin Authors\n# SPDX-License-Identifier: Apache-2.0\n#\n\n# Use latest version here: https://github.com/orgs/openzipkin/packages/container/package/alpine\n# This is defined in many places because Docker has no \"env\" script functionality unless you use\n# docker-compose: When updating, update everywhere.\nARG alpine_version=3.21.3\n\n# We copy files from the context into a scratch container first to avoid a problem where docker and\n# docker compose don't share layer hashes https://github.com/docker/compose/issues/883 normally.\n# COPY --from= works around the issue.\nFROM scratch as scratch\n\nCOPY build-bin/docker/docker-healthcheck /docker-bin/\nCOPY docker/test-images/zipkin-mysql/start-mysql /docker-bin/\nCOPY docker/test-images/zipkin-mysql/install.sh /install/\nCOPY zipkin-storage/mysql-v1/src/main/resources/mysql.sql /zipkin-schemas/\n\nFROM ghcr.io/openzipkin/alpine:${alpine_version} as zipkin-mysql\nLABEL org.opencontainers.image.description=\"MySQL on Alpine Linux with Zipkin schema pre-installed\"\n\n# Add HEALTHCHECK and ENTRYPOINT scripts into the default search path\nCOPY --from=scratch /docker-bin/* /usr/local/bin/\n# We use start period of 30s to avoid marking the container unhealthy on slow or contended CI hosts\nHEALTHCHECK --interval=1s --start-period=30s --timeout=5s CMD [\"docker-healthcheck\"]\nENTRYPOINT [\"start-mysql\"]\n\n# Use latest from https://pkgs.alpinelinux.org/packages?name=mysql (without the -r[0-9])\nARG mysql_version=11.8.5-r1\nLABEL mysql-version=$mysql_version\nENV MYSQL_VERSION=$mysql_version\n\nWORKDIR /tmp\nCOPY --from=scratch /zipkin-schemas/* ./install/zipkin-schemas/\nCOPY --from=scratch /install/install.sh ./install\nRUN (cd install && ./install.sh) && rm -rf ./install\n\n# All content including binaries and logs write under WORKDIR\nARG USER=mysql\nWORKDIR /${USER}\n\nEXPOSE 3306\n" }, { "path": "docker/test-images/zipkin-mysql/README.md", "content": "## zipkin-mysql Docker image\n\nThe `zipkin-mysql` testing image runs MySQL 10.x initialized with Zipkin's schema for\n[MySQL storage](../../../zipkin-storage/mysql-v1) integration.\n\nTo build `openzipkin/zipkin-mysql:test`, from the top-level of the repository, run:\n```bash\n$ DOCKER_FILE=docker/test-images/zipkin-mysql/Dockerfile build-bin/docker/docker_build openzipkin/zipkin-mysql:test\n```\n\nWhen running with docker-machine, you can connect like so:\n\n```bash\n$ mysql -h $(docker-machine ip) -u zipkin -pzipkin -D zipkin\n```\n" }, { "path": "docker/test-images/zipkin-mysql/install.sh", "content": "#!/bin/sh\n#\n# Copyright The OpenZipkin Authors\n# SPDX-License-Identifier: Apache-2.0\n#\n\nset -eux\n\necho \"*** Installing MySQL\"\napk add --update --no-cache mysql=~${MYSQL_VERSION} mysql-client=~${MYSQL_VERSION}\n# Fake auth tools install as 10.4.0 install dies otherwise\nmkdir -p /auth_pam_tool_dir/auth_pam_tool\n\nmysql_opts=\"--user=mysql --basedir=${PWD} --datadir=${PWD}/data --tmpdir=/tmp\"\n\n# Create the database (stored in the data directory)\nln -s /usr/bin bin\nln -s /usr/share share\nmysql_install_db ${mysql_opts} --force\n\n# Enable networking\necho skip-networking=0 >> /etc/my.cnf\necho bind-address=0.0.0.0 >> /etc/my.cnf\n\n# Prevent \"Bind on unix socket: No such file or directory\"\nmkdir -p /run/mysqld/ && chown mysql /run/mysqld/\n\necho \"*** Starting MySQL\"\nmysqld ${mysql_opts} &\ntemp_mysql_pid=$!\n\n# Excessively long timeout to avoid having to create an ENV variable, decide its name, etc.\ntimeout=180\necho \"Will wait up to ${timeout} seconds for MySQL to come up before installing Schema\"\nwhile [ \"$timeout\" -gt 0 ] && kill -0 ${temp_mysql_pid} && ! mysql --protocol=socket -uroot -e 'SELECT 1' > /dev/null 2>&1; do\n sleep 1\n timeout=$(($timeout - 1))\ndone\n\necho \"*** Installing Schema\"\nmysql --verbose --user=mysql --protocol=socket -uroot <<-'EOF'\nUSE mysql ;\n\nDELETE FROM mysql.user ;\nDROP DATABASE IF EXISTS test ;\n\nCREATE DATABASE zipkin ;\n\nUSE zipkin;\nSOURCE zipkin-schemas/mysql.sql ;\n\nGRANT ALL PRIVILEGES ON zipkin.* TO zipkin@'%' IDENTIFIED BY 'zipkin' WITH GRANT OPTION ;\nFLUSH PRIVILEGES ;\nEOF\n\necho \"*** Stopping MySQL\"\nkill ${temp_mysql_pid}\nwait\n\necho \"*** Copying database to /mysql/data\"\nmkdir /mysql\nmv data /mysql/\nchown -R mysql /mysql\n\necho \"*** Cleaning Up\"\napk del mysql-client\nrm bin share\n# Remove large binaries\n(cd /usr/bin; rm -f mysql_* aria_* mysqlbinlog myis* test-connect-t mysqlslap innochecksum resolve* my_print_defaults sst_dump)\n" }, { "path": "docker/test-images/zipkin-mysql/start-mysql", "content": "#!/bin/sh\n#\n# Copyright The OpenZipkin Authors\n# SPDX-License-Identifier: Apache-2.0\n#\n\n# ENTRYPOINT script that starts MySQL\n#\n# This intentionally locates config using the current working directory, in order to consolidate\n# Dockerfile instructions to WORKDIR\nset -eu\n\n# Configure the Docker HEALTHCHECK\nexport HEALTHCHECK_PORT=3306\nexport HEALTHCHECK_KIND=tcp\n\necho Starting MySQL\nMYSQL_OPTS=\"--user=mysql --basedir=${PWD} --datadir=${PWD}/data --tmpdir=/tmp\"\nexec mysqld_safe ${MYSQL_OPTS}\n" }, { "path": "docker/test-images/zipkin-opensearch2/Dockerfile", "content": "#\n# Copyright The OpenZipkin Authors\n# SPDX-License-Identifier: Apache-2.0\n#\n\n# java_version is used for install and runtime layers of zipkin-opensearch2\n#\n# Use latest version here: https://github.com/orgs/openzipkin/packages/container/package/java\n# This is defined in many places because Docker has no \"env\" script functionality unless you use\n# docker-compose: When updating, update everywhere.\nARG java_version=21.0.7_p6\n\n# We copy files from the context into a scratch container first to avoid a problem where docker and\n# docker compose don't share layer hashes https://github.com/docker/compose/issues/883 normally.\n# COPY --from= works around the issue.\nFROM scratch as scratch\n\nCOPY build-bin/docker/docker-healthcheck /docker-bin/\nCOPY docker/test-images/zipkin-opensearch2/start-opensearch /docker-bin/\nCOPY docker/test-images/zipkin-opensearch2/config/ /config/\n\nFROM ghcr.io/openzipkin/java:${java_version} as install\n\nWORKDIR /install\n\n# Use latest 2.x version from https://opensearch.org/downloads.html\n# This is defined in many places because Docker has no \"env\" script functionality unless you use\n# docker-compose: When updating, update everywhere.\nARG opensearch2_version=2.19.0\n\n# Download only the OSS distribution (lacks X-Pack)\nRUN \\\n# Connection resets are frequent in GitHub Actions workflows \\\nwget --random-wait --tries=5 -qO- \\\n# We don't download bin scripts as we customize for reasons including BusyBox problems\nhttps://artifacts.opensearch.org/releases/bundle/opensearch/${opensearch2_version}/opensearch-${opensearch2_version}-linux-x64.tar.gz| tar xz \\\n --wildcards --strip=1 --exclude=jdk\nCOPY --from=scratch /config/ ./config/\n\n# Use a full Java distribution rather than adding test modules to the\n# production -jre base layer used by zipkin and zipkin-slim.\nFROM ghcr.io/openzipkin/java:${java_version} as zipkin-opensearch2\nLABEL org.opencontainers.image.description=\"OpenSearch distribution on OpenJDK and Alpine Linux\"\nARG opensearch2_version=2.19.0\nLABEL opensearch-version=$opensearch2_version\n\n# The full license is also included in the image at /opensearch/LICENSE.txt.\nLABEL org.opencontainers.image.licenses=\"Apache-2.0\"\n\n# Add HEALTHCHECK and ENTRYPOINT scripts into the default search path\nCOPY --from=scratch /docker-bin/* /usr/local/bin/\n# We use start period of 30s to avoid marking the container unhealthy on slow or contended CI hosts\nHEALTHCHECK --interval=1s --start-period=30s --timeout=5s CMD [\"docker-healthcheck\"]\nENTRYPOINT [\"sh\", \"/usr/local/bin/start-opensearch\"]\n\n# All content including binaries and logs write under WORKDIR\nARG USER=opensearch\nWORKDIR /${USER}\n\n# Ensure the process doesn't run as root\nRUN adduser -g '' -h ${PWD} -D ${USER}\nUSER ${USER}\n\n# Copy binaries and config we installed earlier\nCOPY --from=install --chown=${USER} /install .\n\n# Use to set heap, trust store or other system properties.\nENV OPENSEARCH_JAVA_OPTS=\"-Xms512m -Xmx512m -XX:+ExitOnOutOfMemoryError\"\nENV LIBFFI_TMPDIR=/tmp\nEXPOSE 9200\n" }, { "path": "docker/test-images/zipkin-opensearch2/README.md", "content": "## zipkin-opensearch2 Docker image\n\nThe `zipkin-opensearch2` testing image runs OpenSearch 2.x for [Elasticsearch storage](../../../zipkin-storage/elasticsearch)\nintegration.\n\nTo build `openzipkin/zipkin-opensearch2:test`, from the top-level of the repository, run:\n```bash\n$ DOCKER_FILE=docker/test-images/zipkin-opensearch2/Dockerfile build-bin/docker/docker_build openzipkin/zipkin-opensearch2:test\n```\n\nYou can use the env variable `OPENSEARCH_JAVA_OPTS` to change settings such as heap size for OpenSearch.\n\n#### Host setup\n\nOpenSearch is [strict](https://github.com/docker-library/docs/tree/master/elasticsearch#host-setup)\nabout virtual memory. You will need to adjust accordingly (especially if you notice OpenSearch crash!)\n\n```bash\n# If docker is running on your host machine, adjust the kernel setting directly\n$ sudo sysctl -w vm.max_map_count=262144\n\n# If using docker-machine/Docker Toolbox/Boot2Docker, remotely adjust the same\n$ docker-machine ssh default \"sudo sysctl -w vm.max_map_count=262144\"\n\n# If using colima, it is similar as well\n$ colima ssh \"sudo sysctl -w vm.max_map_count=262144\"\n```\n" }, { "path": "docker/test-images/zipkin-opensearch2/config/log4j2.properties", "content": "#\n# Copyright The OpenZipkin Authors\n# SPDX-License-Identifier: Apache-2.0\n#\n\nstatus = error\n\nappender.console.type = Console\nappender.console.name = console\nappender.console.layout.type = PatternLayout\nappender.console.layout.pattern = [%d{ISO8601}][%-5p][%-25c{1.}] [%node_name]%marker %m%n\n\nrootLogger.level = info\nrootLogger.appenderRef.console.ref = console\n" }, { "path": "docker/test-images/zipkin-opensearch2/config/opensearch.yml", "content": "#\n# Copyright The OpenZipkin Authors\n# SPDX-License-Identifier: Apache-2.0\n#\n\ncluster.name: \"docker-cluster\"\nnetwork.host: 0.0.0.0\nnode.name: zipkin-opensearch\n\n# Enable development mode and disable bootstrap checks\n# See https://www.elastic.co/guide/en/elasticsearch/reference/current/bootstrap-checks.html\ndiscovery.type: single-node\n# Avoid deprecation errors: as of 2.x the only accepted value is true.\ncluster.routing.allocation.disk.watermark.enable_for_single_data_node: true\n\n# This is a test image, so we are not afraid to delete all indices. Avoids:\n# Wildcard expressions or all indices are not allowed\naction.destructive_requires_name: false\n\n# Disable security\nplugins.security.disabled: true\n" }, { "path": "docker/test-images/zipkin-opensearch2/start-opensearch", "content": "#!/bin/sh\n#\n# Copyright The OpenZipkin Authors\n# SPDX-License-Identifier: Apache-2.0\n#\n\n# ENTRYPOINT script that starts OpenSearch\n#\n# This intentionally locates config using the current working directory, in order to consolidate\n# Dockerfile instructions to WORKDIR\nset -eu\n\n# Configure the Docker HEALTHCHECK\nexport HEALTHCHECK_PORT=9200\nexport HEALTHCHECK_PATH=/_cluster/health\n\n# Use the 'java.io.tmp' dir and precreate the 'opensearch' folder there\nexport OPENSEARCH_TMPDIR=`java -cp 'classes:lib/*' org.opensearch.tools.launchers.TempDirectory`\n\n# The JVM options parser produces the final JVM options to start OpenSearch.\n# It does this by incorporating JVM options in the following way:\n# - first, system JVM options are applied (these are hardcoded options in the\n# parser)\n# - second, JVM options are read from jvm.options and jvm.options.d/*.options\n# - third, JVM options from OPENSEARCH_JAVA_OPTS are applied\n# - fourth, ergonomic JVM options are applied\nOPENSEARCH_JAVA_OPTS=`java -cp 'classes:lib/*' org.opensearch.tools.launchers.JvmOptionsParser \"$PWD/config\"`\n\n# -cp 'classes:lib/*' allows layers to patch the image without packaging or overwriting jars\n# We allow security manager (via flag to prevent JRE 21 crash) as OpenSearch.main needs it.\nexec java -cp 'classes:lib/*' ${OPENSEARCH_JAVA_OPTS} \\\n -Djava.security.manager=allow \\\n -Djava.io.tmpdir=/tmp \\\n -Dlog4j2.disable.jmx=true \\\n -Dopensearch.path.home=$PWD \\\n -Dopensearch.path.conf=$PWD/config \\\n -Dopensearch.distribution.type=docker \\\n -Dopensearch.bundled_jdk=false \\\n org.opensearch.bootstrap.OpenSearch \"$@\"\n" }, { "path": "docker/test-images/zipkin-pulsar/Dockerfile", "content": "#\n# Copyright The OpenZipkin Authors\n# SPDX-License-Identifier: Apache-2.0\n#\n\n# Use latest from https://hub.docker.com/r/apachepulsar/pulsar/tags\nARG pulsar_version=4.0.2\n\n# We copy files from the context into a scratch container first to avoid a problem where docker and\n# docker compose don't share layer hashes https://github.com/docker/compose/issues/883 normally.\n# COPY --from= works around the issue.\nFROM scratch as scratch\n\nWORKDIR /docker-bin\nCOPY build-bin/docker/docker-healthcheck /docker-bin/\n\nARG pulsar_version\n\nFROM apachepulsar/pulsar:${pulsar_version} as zipkin-pulsar\nLABEL pulsar-version=$pulsar_version\nLABEL org.opencontainers.image.description=\"Apache Pulsar on Alpine Linux\"\n\n# Add HEALTHCHECK and ENTRYPOINT scripts into the default search path\nCOPY --from=scratch /docker-bin/* /usr/local/bin/\n# We use start period of 30s to avoid marking the container unhealthy on slow or contended CI hosts\nHEALTHCHECK --interval=1s --start-period=30s --timeout=5s CMD [\"docker-healthcheck\"]\n\n# Usually, we read env set from pid 1 to get docker-healthcheck parameters.\n# However, pulsar-server has to start as root even if permissions are dropped\n# later. So, we expose it in the Dockerfile instead.\nENV HEALTHCHECK_PORT=8080\nENV HEALTHCHECK_KIND=http\nENV HEALTHCHECK_PATH=/admin/v2/clusters/standalone\nENV PULSAR_LOG_ROOT_LEVEL=WARN\nEXPOSE 8080 6650\nCMD [\"bin/pulsar\", \"standalone\"]" }, { "path": "docker/test-images/zipkin-pulsar/README.md", "content": "## zipkin-pulsar Docker image\n\nThe `zipkin-pulsar` testing image runs Pulsar for Pulsar collector integration.\n\nTo build `openzipkin/zipkin-pulsar:test`, from the top-level of the repository, run:\n```bash\n$ DOCKER_FILE=docker/test-images/zipkin-pulsar/Dockerfile build-bin/docker/docker_build openzipkin/zipkin-pulsar:test\n```\n\nYou can use the env variable `PULSAR_LOG_ROOT_LEVEL` to change the log level for Pulsar. Defaults to \"WARN\"." }, { "path": "docker/test-images/zipkin-rabbitmq/Dockerfile", "content": "#\n# Copyright The OpenZipkin Authors\n# SPDX-License-Identifier: Apache-2.0\n#\n\n# Use latest from https://hub.docker.com/_/rabbitmq/tags?page=1&name=alpine\nARG rabbitmq_version=3.13.7\n\n# We copy files from the context into a scratch container first to avoid a problem where docker and\n# docker compose don't share layer hashes https://github.com/docker/compose/issues/883 normally.\n# COPY --from= works around the issue.\nFROM scratch as scratch\n\nWORKDIR /docker-bin\nCOPY build-bin/docker/docker-healthcheck /docker-bin/\n# Bootstrap config including a queue setup out-of-band, exported like so:\n# rabbitmqctl export_definitions defs.json\nCOPY docker/test-images/zipkin-rabbitmq/config/* /config/\n\nARG rabbitmq_version\n\nFROM rabbitmq:${rabbitmq_version}-alpine as zipkin-rabbitmq\nLABEL rabbitmq-version=$rabbitmq_version\nLABEL org.opencontainers.image.description=\"RabbitMQ on Alpine Linux\"\n\n# Add HEALTHCHECK and ENTRYPOINT scripts into the default search path\nCOPY --from=scratch /docker-bin/* /usr/local/bin/\n# We use start period of 30s to avoid marking the container unhealthy on slow or contended CI hosts\nHEALTHCHECK --interval=1s --start-period=30s --timeout=5s CMD [\"docker-healthcheck\"]\n\nCOPY --from=scratch /config/* /etc/rabbitmq/\n\nRUN apk add --update --no-cache rabbitmq-c-utils\n\n# Usually, we read env set from pid 1 to get docker-healthcheck parameters.\n# However, rabbitmq-server has to start as root even if permissions are dropped\n# later. So, we expose it in the Dockerfile instead.\nENV HEALTHCHECK_PORT=5672\nENV HEALTHCHECK_KIND=tcp\nEXPOSE 5672\n" }, { "path": "docker/test-images/zipkin-rabbitmq/README.md", "content": "## zipkin-rabbitmq Docker image\n\nThe `zipkin-rabbitmq` testing image runs `rabbitmq-server` for the\n[RabbitMQ collector](../../../zipkin-collector/rabbitmq) integration.\n\nFor convenience, this includes the \"guest\" user and a default queue named\n\"zipkin\". To add more queues, exec `amqp-declare-queue` in a running container.\n\nTo build `openzipkin/zipkin-rabbitmq:test`, from the top-level of the repository, run:\n```bash\n$ DOCKER_FILE=docker/test-images/zipkin-rabbitmq/Dockerfile build-bin/docker/docker_build openzipkin/zipkin-rabbitmq:test\n```\n" }, { "path": "docker/test-images/zipkin-rabbitmq/config/defs.json", "content": "{\n \"permissions\": [\n {\n \"configure\": \".*\",\n \"read\": \".*\",\n \"user\": \"guest\",\n \"vhost\": \"/\",\n \"write\": \".*\"\n }\n ],\n \"bindings\": [],\n \"queues\": [\n {\n \"arguments\": {},\n \"auto_delete\": false,\n \"durable\": false,\n \"name\": \"zipkin\",\n \"type\": \"classic\",\n \"vhost\": \"/\"\n }\n ],\n \"parameters\": [],\n \"policies\": [],\n \"vhosts\": [\n {\n \"limits\": [],\n \"metadata\": {\n \"description\": \"Default virtual host\",\n \"tags\": []\n },\n \"name\": \"/\"\n }\n ],\n \"exchanges\": [],\n \"global_parameters\": [],\n \"topic_permissions\": [],\n \"users\": [\n {\n \"hashing_algorithm\": \"rabbit_password_hashing_sha256\",\n \"limits\": {},\n \"name\": \"guest\",\n \"password_hash\": \"s4XuI8xVMHg3To1FSsFSnsQ2vfgMTP0/XJtmh3plzM/u86Es\",\n \"tags\": [\n \"administrator\"\n ]\n }\n ]\n}" }, { "path": "docker/test-images/zipkin-rabbitmq/config/rabbitmq.conf", "content": "# Does not require management plugin to be enabled.\nloopback_users.guest = false\ndefinitions.import_backend = local_filesystem\ndefinitions.local.path = /etc/rabbitmq/defs.json\n" }, { "path": "docker/test-images/zipkin-ui/Dockerfile", "content": "#\n# Copyright The OpenZipkin Authors\n# SPDX-License-Identifier: Apache-2.0\n#\n\n# Use latest version here: https://github.com/orgs/openzipkin/packages/container/package/alpine\n# This is defined in many places because Docker has no \"env\" script functionality unless you use\n# docker-compose: When updating, update everywhere.\nARG alpine_version=3.21.3\n\n# java_version is used during the installation process to build or download the zipkin-lens jar.\n#\n# Use latest version here: https://github.com/orgs/openzipkin/packages/container/package/java\n# This is defined in many places because Docker has no \"env\" script functionality unless you use\n# docker-compose: When updating, update everywhere.\nARG java_version=21.0.7_p6\n\n# We copy files from the context into a scratch container first to avoid a problem where docker and\n# docker compose don't share layer hashes https://github.com/docker/compose/issues/883 normally.\n# COPY --from= works around the issue.\nFROM scratch as scratch\n\nCOPY build-bin/ /build-bin/\nCOPY build-bin/docker/docker-healthcheck /docker-bin/\nCOPY docker/test-images/zipkin-ui/start-nginx /docker-bin/\nCOPY docker/test-images/zipkin-ui/nginx.conf /conf.d/zipkin.conf.template\nCOPY . /code/\n\n# This version is only used during the install process. Try to be consistent as it reduces layers,\n# which reduces downloads.\nFROM ghcr.io/openzipkin/java:${java_version} as install\n\nCOPY --from=scratch /build-bin/ /build-bin/\n\nWORKDIR /code\n# Conditions aren't supported in Dockerfile instructions, so we copy source even if it isn't used.\nCOPY --from=scratch /code/ .\n\nWORKDIR /install\n\n# When true, build-bin/maven/unjar searches /code for the artifact instead of resolving remotely.\n# /code contains what is allowed in .dockerignore. On problem, ensure .dockerignore is correct.\nARG release_from_maven_build=false\nENV RELEASE_FROM_MAVEN_BUILD=$release_from_maven_build\n# Version of the artifact to unjar. Ex. \"2.4.5\" or \"2.4.5-SNAPSHOT\" \"master\" to use the pom version.\nARG version=master\nENV VERSION=$version\nENV MAVEN_PROJECT_BASEDIR=/code\nRUN if [ \"${RELEASE_FROM_MAVEN_BUILD}\" == \"false\" ]; then /build-bin/maybe_install_npm; fi; \\\n /build-bin/maven/maven_build_or_unjar io.zipkin zipkin-lens ${VERSION}\n\nFROM ghcr.io/openzipkin/alpine:$alpine_version as zipkin-ui\nLABEL org.opencontainers.image.description=\"NGINX on Alpine Linux hosting the Zipkin UI with Zipkin API proxy_pass\"\n# Use latest from https://pkgs.alpinelinux.org/packages?name=nginx\nARG nginx_version=1.28.2-r2\nLABEL nginx-version=$nginx_version\n\nENV ZIPKIN_BASE_URL=http://zipkin:9411\n\n# Add HEALTHCHECK and ENTRYPOINT scripts into the default search path\nCOPY --from=scratch /docker-bin/* /usr/local/bin/\n# We use start period of 30s to avoid marking the container unhealthy on slow or contended CI hosts\nHEALTHCHECK --interval=1s --start-period=30s --timeout=5s CMD [\"docker-healthcheck\"]\nENTRYPOINT [\"start-nginx\"]\n\n# Add content and setup NGINX\nCOPY --from=install /install/zipkin-lens/* /var/www/html/zipkin/\nCOPY --from=scratch /conf.d/ /etc/nginx/conf.d/\nRUN apk add --update --no-cache nginx=~${nginx_version} && \\\n mkdir -p /var/tmp/nginx && chown -R nginx:nginx /var/tmp/nginx\n\n# Usually, we read env set from pid 1 to get docker-healthcheck parameters. However, NGINX wipes the\n# env, so we need to expose it in the Dockerfile instead.\nENV HEALTHCHECK_PORT=80\nEXPOSE 80\n" }, { "path": "docker/test-images/zipkin-ui/README.md", "content": "## zipkin-ui Docker image\n\nThe `zipkin-ui` testing image contains the static parts of the Zipkin UI served directly with NGINX.\n\nBesides norms defined in [docker-alpine](https://github.com/openzipkin/docker-alpine), this accepts the\nfollowing environment variables:\n\n* `ZIPKIN_BASE_URL`: The proxied zipkin base URL. Defaults to http://zipkin:9411\n\nTo build `openzipkin/zipkin-ui:test`, from the top-level of the repository, run:\n```bash\n$ DOCKER_FILE=docker/test-images/zipkin-ui/Dockerfile build-bin/docker/docker_build openzipkin/zipkin-ui:test\n```\n" }, { "path": "docker/test-images/zipkin-ui/nginx.conf", "content": "user nginx nginx;\nworker_processes 2;\n\nerror_log /dev/stdout warn;\npid /var/run/nginx.pid;\n\ndaemon off;\n\nevents {\n worker_connections 1024;\n}\n\n\nhttp {\n include /etc/nginx/mime.types;\n default_type application/octet-stream;\n\n log_format main '$remote_addr - $remote_user [$time_local] \"$request\" '\n '$status $body_bytes_sent \"$http_referer\" '\n '\"$http_user_agent\" \"$http_x_forwarded_for\"';\n\n access_log /dev/stdout main;\n\n sendfile on;\n #tcp_nopush on;\n\n keepalive_timeout 65;\n\n gzip on;\n gzip_types application/javascript application/json text/css;\n\n server_tokens off;\n\n types {\n application/font-woff2 woff2;\n }\n\n server {\n listen 80;\n\n root /var/www/html;\n\n index index.html;\n\n # Make site accessible from http://set-ip-address.xip.io\n server_name localhost;\n\n charset utf-8;\n\n # redirect root as UI is hosted under /zipkin\n location / {\n return 302 /zipkin/;\n }\n\n # the entrypoint of the app will expire every day.\n # this includes links to js assets with random names.\n location /zipkin/index.html {\n expires 1d;\n }\n\n location /zipkin {\n try_files $uri /zipkin/index.html = 404;\n }\n\n # Pass through health check to the proxy for our docker HEALTHCHECK\n location /health {\n expires 1s;\n access_log off;\n error_log off;\n # start-nginx overrides the base url to $ZIPKIN_UI_BASEPATH\n proxy_pass http://localhost:9411;\n }\n\n # accept UI config from the server\n location /zipkin/config.json {\n expires 10m;\n # start-nginx overrides the base url to $ZIPKIN_BASE_URL\n proxy_pass http://localhost:9411;\n }\n\n # the UI looks for the api under the same relative path\n location /zipkin/api {\n expires off;\n # start-nginx overrides the base url to $ZIPKIN_BASE_URL\n proxy_pass http://localhost:9411;\n }\n\n # due to minification, the js assets will change names.\n # this makes them safe to cache longer\n location ~* \\.(?:ico|css|js|gif|jpe?g|png)$ {\n expires 1y;\n add_header Cache-Control \"public\";\n }\n\n location = /favicon.ico { log_not_found off; access_log off; }\n location = /robots.txt { access_log off; log_not_found off; }\n\n # Deny .htaccess file access\n location ~ /\\.ht {\n deny all;\n }\n\n }\n}\n" }, { "path": "docker/test-images/zipkin-ui/start-nginx", "content": "#!/bin/sh\n#\n# Copyright The OpenZipkin Authors\n# SPDX-License-Identifier: Apache-2.0\n#\n\nsed \"s~proxy_pass http://localhost:9411~proxy_pass ${ZIPKIN_BASE_URL}~g\" \\\n /etc/nginx/conf.d/zipkin.conf.template > /etc/nginx/nginx.conf\n\necho Starting NGINX\nexec nginx \"$@\"\n" }, { "path": "docker/test-images/zipkin-uiproxy/Dockerfile", "content": "#\n# Copyright The OpenZipkin Authors\n# SPDX-License-Identifier: Apache-2.0\n#\n\n# Use latest version here: https://github.com/orgs/openzipkin/packages/container/package/alpine\n# This is defined in many places because Docker has no \"env\" script functionality unless you use\n# docker-compose: When updating, update everywhere.\nARG alpine_version=3.21.3\n\n# java_version is used during the installation process to build or download the zipkin-lens jar.\n#\n# Use latest version here: https://github.com/orgs/openzipkin/packages/container/package/java\n# This is defined in many places because Docker has no \"env\" script functionality unless you use\n# docker-compose: When updating, update everywhere.\nARG java_version=21.0.7_p6\n\n# We copy files from the context into a scratch container first to avoid a problem where docker and\n# docker compose don't share layer hashes https://github.com/docker/compose/issues/883 normally.\n# COPY --from= works around the issue.\nFROM scratch as scratch\n\nCOPY build-bin/ /build-bin/\nCOPY build-bin/docker/docker-healthcheck /docker-bin/\nCOPY docker/test-images/zipkin-uiproxy/start-nginx /docker-bin/\nCOPY docker/test-images/zipkin-uiproxy/nginx.conf /conf.d/zipkin.conf.template\n\nFROM ghcr.io/openzipkin/alpine:$alpine_version as zipkin-uiproxy\nLABEL org.opencontainers.image.description=\"NGINX on Alpine Linux proxying the Zipkin UI with proxy_pass\"\n# Use latest from https://pkgs.alpinelinux.org/packages?name=nginx\nARG nginx_version=1.28.2-r2\nLABEL nginx-version=$nginx_version\n\nENV ZIPKIN_UI_BASEPATH=/zipkin\nENV ZIPKIN_BASE_URL=http://zipkin:9411\n\n# Add HEALTHCHECK and ENTRYPOINT scripts into the default search path\nCOPY --from=scratch /docker-bin/* /usr/local/bin/\n# We use start period of 30s to avoid marking the container unhealthy on slow or contended CI hosts\nHEALTHCHECK --interval=1s --start-period=30s --timeout=5s CMD [\"docker-healthcheck\"]\nENTRYPOINT [\"start-nginx\"]\n\n# Setup NGINX\nCOPY --from=scratch /conf.d/ /etc/nginx/conf.d/\nRUN apk add --update --no-cache nginx=~${nginx_version} && \\\n mkdir -p /var/tmp/nginx && chown -R nginx:nginx /var/tmp/nginx\n\n# Usually, we read env set from pid 1 to get docker-healthcheck parameters. However, NGINX wipes the\n# env, so we need to expose it in the Dockerfile instead.\nENV HEALTHCHECK_PORT=80\nEXPOSE 80\n" }, { "path": "docker/test-images/zipkin-uiproxy/README.md", "content": "## zipkin-uiproxy Docker image\n\nThe `zipkin-uiproxy` testing image proxies the Zipkin UI with NGINX.\n\nBesides norms defined in [docker-alpine](https://github.com/openzipkin/docker-alpine), this accepts the\nfollowing environment variables:\n\n* `ZIPKIN_UI_BASEPATH`: The path this proxy serves the UI under. Defaults to /zipkin\n* `ZIPKIN_BASE_URL`: The proxied zipkin base URL. Defaults to http://zipkin:9411\n\nTo build `openzipkin/zipkin-ui:test`, from the top-level of the repository, run:\n```bash\n$ DOCKER_FILE=docker/test-images/zipkin-uiproxy/Dockerfile build-bin/docker/docker_build openzipkin/zipkin-uiproxy:test\n```\n" }, { "path": "docker/test-images/zipkin-uiproxy/nginx.conf", "content": "user nginx nginx;\nworker_processes 2;\n\nerror_log /dev/stdout warn;\npid /var/run/nginx.pid;\n\ndaemon off;\n\nevents {\n worker_connections 1024;\n}\n\n\nhttp {\n include /etc/nginx/mime.types;\n default_type application/octet-stream;\n\n log_format main '$remote_addr - $remote_user [$time_local] \"$request\" '\n '$status $body_bytes_sent \"$http_referer\" '\n '\"$http_user_agent\" \"$http_x_forwarded_for\"';\n\n access_log /dev/stdout main;\n\n sendfile on;\n\n keepalive_timeout 65;\n\n gzip on;\n gzip_types application/javascript application/json text/css;\n\n server_tokens off;\n\n server {\n listen 80;\n\n root /var/www/html;\n\n index index.html;\n\n # Make site accessible from http://set-ip-address.xip.io\n server_name localhost;\n\n charset utf-8;\n\n # start-nginx overrides /zipkin to $ZIPKIN_UI_BASEPATH\n location /zipkin {\n # start-nginx overrides the base url to $ZIPKIN_BASE_URL\n proxy_pass http://localhost:9411/zipkin;\n proxy_redirect default;\n }\n\n # Pass through health check to the proxy for our docker HEALTHCHECK\n location /health {\n expires 1s;\n access_log off;\n error_log off;\n # start-nginx overrides the base url to $ZIPKIN_BASE_URL\n proxy_pass http://localhost:9411;\n }\n\n\n location = /favicon.ico { log_not_found off; access_log off; }\n location = /robots.txt { access_log off; log_not_found off; }\n\n # Deny .htaccess file access\n location ~ /\\.ht {\n deny all;\n }\n\n }\n}\n" }, { "path": "docker/test-images/zipkin-uiproxy/start-nginx", "content": "#!/bin/sh\n#\n# Copyright The OpenZipkin Authors\n# SPDX-License-Identifier: Apache-2.0\n#\n\nsed -e \"s~proxy_pass http://localhost:9411~proxy_pass ${ZIPKIN_BASE_URL}~g\" \\\n -e \"s~location /zipkin~location ${ZIPKIN_UI_BASEPATH}~g\" \\\n /etc/nginx/conf.d/zipkin.conf.template > /etc/nginx/nginx.conf\n\necho Starting NGINX\nexec nginx \"$@\"\n" }, { "path": "mvnw", "content": "#!/bin/sh\n# ----------------------------------------------------------------------------\n# Licensed to the Apache Software Foundation (ASF) under one\n# or more contributor license agreements. See the NOTICE file\n# distributed with this work for additional information\n# regarding copyright ownership. The ASF licenses this file\n# to you under the Apache License, Version 2.0 (the\n# \"License\"); you may not use this file except in compliance\n# with the License. You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing,\n# software distributed under the License is distributed on an\n# \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY\n# KIND, either express or implied. See the License for the\n# specific language governing permissions and limitations\n# under the License.\n# ----------------------------------------------------------------------------\n\n# ----------------------------------------------------------------------------\n# Apache Maven Wrapper startup batch script, version 3.3.2\n#\n# Required ENV vars:\n# ------------------\n# JAVA_HOME - location of a JDK home dir\n#\n# Optional ENV vars\n# -----------------\n# MAVEN_OPTS - parameters passed to the Java VM when running Maven\n# e.g. to debug Maven itself, use\n# set MAVEN_OPTS=-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=8000\n# MAVEN_SKIP_RC - flag to disable loading of mavenrc files\n# ----------------------------------------------------------------------------\n\nif [ -z \"$MAVEN_SKIP_RC\" ]; then\n\n if [ -f /usr/local/etc/mavenrc ]; then\n . /usr/local/etc/mavenrc\n fi\n\n if [ -f /etc/mavenrc ]; then\n . /etc/mavenrc\n fi\n\n if [ -f \"$HOME/.mavenrc\" ]; then\n . \"$HOME/.mavenrc\"\n fi\n\nfi\n\n# OS specific support. $var _must_ be set to either true or false.\ncygwin=false\ndarwin=false\nmingw=false\ncase \"$(uname)\" in\nCYGWIN*) cygwin=true ;;\nMINGW*) mingw=true ;;\nDarwin*)\n darwin=true\n # Use /usr/libexec/java_home if available, otherwise fall back to /Library/Java/Home\n # See https://developer.apple.com/library/mac/qa/qa1170/_index.html\n if [ -z \"$JAVA_HOME\" ]; then\n if [ -x \"/usr/libexec/java_home\" ]; then\n JAVA_HOME=\"$(/usr/libexec/java_home)\"\n export JAVA_HOME\n else\n JAVA_HOME=\"/Library/Java/Home\"\n export JAVA_HOME\n fi\n fi\n ;;\nesac\n\nif [ -z \"$JAVA_HOME\" ]; then\n if [ -r /etc/gentoo-release ]; then\n JAVA_HOME=$(java-config --jre-home)\n fi\nfi\n\n# For Cygwin, ensure paths are in UNIX format before anything is touched\nif $cygwin; then\n [ -n \"$JAVA_HOME\" ] \\\n && JAVA_HOME=$(cygpath --unix \"$JAVA_HOME\")\n [ -n \"$CLASSPATH\" ] \\\n && CLASSPATH=$(cygpath --path --unix \"$CLASSPATH\")\nfi\n\n# For Mingw, ensure paths are in UNIX format before anything is touched\nif $mingw; then\n [ -n \"$JAVA_HOME\" ] && [ -d \"$JAVA_HOME\" ] \\\n && JAVA_HOME=\"$(\n cd \"$JAVA_HOME\" || (\n echo \"cannot cd into $JAVA_HOME.\" >&2\n exit 1\n )\n pwd\n )\"\nfi\n\nif [ -z \"$JAVA_HOME\" ]; then\n javaExecutable=\"$(which javac)\"\n if [ -n \"$javaExecutable\" ] && ! [ \"$(expr \"$javaExecutable\" : '\\([^ ]*\\)')\" = \"no\" ]; then\n # readlink(1) is not available as standard on Solaris 10.\n readLink=$(which readlink)\n if [ ! \"$(expr \"$readLink\" : '\\([^ ]*\\)')\" = \"no\" ]; then\n if $darwin; then\n javaHome=\"$(dirname \"$javaExecutable\")\"\n javaExecutable=\"$(cd \"$javaHome\" && pwd -P)/javac\"\n else\n javaExecutable=\"$(readlink -f \"$javaExecutable\")\"\n fi\n javaHome=\"$(dirname \"$javaExecutable\")\"\n javaHome=$(expr \"$javaHome\" : '\\(.*\\)/bin')\n JAVA_HOME=\"$javaHome\"\n export JAVA_HOME\n fi\n fi\nfi\n\nif [ -z \"$JAVACMD\" ]; then\n if [ -n \"$JAVA_HOME\" ]; then\n if [ -x \"$JAVA_HOME/jre/sh/java\" ]; then\n # IBM's JDK on AIX uses strange locations for the executables\n JAVACMD=\"$JAVA_HOME/jre/sh/java\"\n else\n JAVACMD=\"$JAVA_HOME/bin/java\"\n fi\n else\n JAVACMD=\"$(\n \\unset -f command 2>/dev/null\n \\command -v java\n )\"\n fi\nfi\n\nif [ ! -x \"$JAVACMD\" ]; then\n echo \"Error: JAVA_HOME is not defined correctly.\" >&2\n echo \" We cannot execute $JAVACMD\" >&2\n exit 1\nfi\n\nif [ -z \"$JAVA_HOME\" ]; then\n echo \"Warning: JAVA_HOME environment variable is not set.\" >&2\nfi\n\n# traverses directory structure from process work directory to filesystem root\n# first directory with .mvn subdirectory is considered project base directory\nfind_maven_basedir() {\n if [ -z \"$1\" ]; then\n echo \"Path not specified to find_maven_basedir\" >&2\n return 1\n fi\n\n basedir=\"$1\"\n wdir=\"$1\"\n while [ \"$wdir\" != '/' ]; do\n if [ -d \"$wdir\"/.mvn ]; then\n basedir=$wdir\n break\n fi\n # workaround for JBEAP-8937 (on Solaris 10/Sparc)\n if [ -d \"${wdir}\" ]; then\n wdir=$(\n cd \"$wdir/..\" || exit 1\n pwd\n )\n fi\n # end of workaround\n done\n printf '%s' \"$(\n cd \"$basedir\" || exit 1\n pwd\n )\"\n}\n\n# concatenates all lines of a file\nconcat_lines() {\n if [ -f \"$1\" ]; then\n # Remove \\r in case we run on Windows within Git Bash\n # and check out the repository with auto CRLF management\n # enabled. Otherwise, we may read lines that are delimited with\n # \\r\\n and produce $'-Xarg\\r' rather than -Xarg due to word\n # splitting rules.\n tr -s '\\r\\n' ' ' <\"$1\"\n fi\n}\n\nlog() {\n if [ \"$MVNW_VERBOSE\" = true ]; then\n printf '%s\\n' \"$1\"\n fi\n}\n\nBASE_DIR=$(find_maven_basedir \"$(dirname \"$0\")\")\nif [ -z \"$BASE_DIR\" ]; then\n exit 1\nfi\n\nMAVEN_PROJECTBASEDIR=${MAVEN_BASEDIR:-\"$BASE_DIR\"}\nexport MAVEN_PROJECTBASEDIR\nlog \"$MAVEN_PROJECTBASEDIR\"\n\n##########################################################################################\n# Extension to allow automatically downloading the maven-wrapper.jar from Maven-central\n# This allows using the maven wrapper in projects that prohibit checking in binary data.\n##########################################################################################\nwrapperJarPath=\"$MAVEN_PROJECTBASEDIR/.mvn/wrapper/maven-wrapper.jar\"\nif [ -r \"$wrapperJarPath\" ]; then\n log \"Found $wrapperJarPath\"\nelse\n log \"Couldn't find $wrapperJarPath, downloading it ...\"\n\n if [ -n \"$MVNW_REPOURL\" ]; then\n wrapperUrl=\"$MVNW_REPOURL/org/apache/maven/wrapper/maven-wrapper/3.3.2/maven-wrapper-3.3.2.jar\"\n else\n wrapperUrl=\"https://repo.maven.apache.org/maven2/org/apache/maven/wrapper/maven-wrapper/3.3.2/maven-wrapper-3.3.2.jar\"\n fi\n while IFS=\"=\" read -r key value; do\n # Remove '\\r' from value to allow usage on windows as IFS does not consider '\\r' as a separator ( considers space, tab, new line ('\\n'), and custom '=' )\n safeValue=$(echo \"$value\" | tr -d '\\r')\n case \"$key\" in wrapperUrl)\n wrapperUrl=\"$safeValue\"\n break\n ;;\n esac\n done <\"$MAVEN_PROJECTBASEDIR/.mvn/wrapper/maven-wrapper.properties\"\n log \"Downloading from: $wrapperUrl\"\n\n if $cygwin; then\n wrapperJarPath=$(cygpath --path --windows \"$wrapperJarPath\")\n fi\n\n if command -v wget >/dev/null; then\n log \"Found wget ... using wget\"\n [ \"$MVNW_VERBOSE\" = true ] && QUIET=\"\" || QUIET=\"--quiet\"\n if [ -z \"$MVNW_USERNAME\" ] || [ -z \"$MVNW_PASSWORD\" ]; then\n wget $QUIET \"$wrapperUrl\" -O \"$wrapperJarPath\" || rm -f \"$wrapperJarPath\"\n else\n wget $QUIET --http-user=\"$MVNW_USERNAME\" --http-password=\"$MVNW_PASSWORD\" \"$wrapperUrl\" -O \"$wrapperJarPath\" || rm -f \"$wrapperJarPath\"\n fi\n elif command -v curl >/dev/null; then\n log \"Found curl ... using curl\"\n [ \"$MVNW_VERBOSE\" = true ] && QUIET=\"\" || QUIET=\"--silent\"\n if [ -z \"$MVNW_USERNAME\" ] || [ -z \"$MVNW_PASSWORD\" ]; then\n curl $QUIET -o \"$wrapperJarPath\" \"$wrapperUrl\" -f -L || rm -f \"$wrapperJarPath\"\n else\n curl $QUIET --user \"$MVNW_USERNAME:$MVNW_PASSWORD\" -o \"$wrapperJarPath\" \"$wrapperUrl\" -f -L || rm -f \"$wrapperJarPath\"\n fi\n else\n log \"Falling back to using Java to download\"\n javaSource=\"$MAVEN_PROJECTBASEDIR/.mvn/wrapper/MavenWrapperDownloader.java\"\n javaClass=\"$MAVEN_PROJECTBASEDIR/.mvn/wrapper/MavenWrapperDownloader.class\"\n # For Cygwin, switch paths to Windows format before running javac\n if $cygwin; then\n javaSource=$(cygpath --path --windows \"$javaSource\")\n javaClass=$(cygpath --path --windows \"$javaClass\")\n fi\n if [ -e \"$javaSource\" ]; then\n if [ ! -e \"$javaClass\" ]; then\n log \" - Compiling MavenWrapperDownloader.java ...\"\n (\"$JAVA_HOME/bin/javac\" \"$javaSource\")\n fi\n if [ -e \"$javaClass\" ]; then\n log \" - Running MavenWrapperDownloader.java ...\"\n (\"$JAVA_HOME/bin/java\" -cp .mvn/wrapper MavenWrapperDownloader \"$wrapperUrl\" \"$wrapperJarPath\") || rm -f \"$wrapperJarPath\"\n fi\n fi\n fi\nfi\n##########################################################################################\n# End of extension\n##########################################################################################\n\n# If specified, validate the SHA-256 sum of the Maven wrapper jar file\nwrapperSha256Sum=\"\"\nwhile IFS=\"=\" read -r key value; do\n case \"$key\" in wrapperSha256Sum)\n wrapperSha256Sum=$value\n break\n ;;\n esac\ndone <\"$MAVEN_PROJECTBASEDIR/.mvn/wrapper/maven-wrapper.properties\"\nif [ -n \"$wrapperSha256Sum\" ]; then\n wrapperSha256Result=false\n if command -v sha256sum >/dev/null; then\n if echo \"$wrapperSha256Sum $wrapperJarPath\" | sha256sum -c >/dev/null 2>&1; then\n wrapperSha256Result=true\n fi\n elif command -v shasum >/dev/null; then\n if echo \"$wrapperSha256Sum $wrapperJarPath\" | shasum -a 256 -c >/dev/null 2>&1; then\n wrapperSha256Result=true\n fi\n else\n echo \"Checksum validation was requested but neither 'sha256sum' or 'shasum' are available.\" >&2\n echo \"Please install either command, or disable validation by removing 'wrapperSha256Sum' from your maven-wrapper.properties.\" >&2\n exit 1\n fi\n if [ $wrapperSha256Result = false ]; then\n echo \"Error: Failed to validate Maven wrapper SHA-256, your Maven wrapper might be compromised.\" >&2\n echo \"Investigate or delete $wrapperJarPath to attempt a clean download.\" >&2\n echo \"If you updated your Maven version, you need to update the specified wrapperSha256Sum property.\" >&2\n exit 1\n fi\nfi\n\nMAVEN_OPTS=\"$(concat_lines \"$MAVEN_PROJECTBASEDIR/.mvn/jvm.config\") $MAVEN_OPTS\"\n\n# For Cygwin, switch paths to Windows format before running java\nif $cygwin; then\n [ -n \"$JAVA_HOME\" ] \\\n && JAVA_HOME=$(cygpath --path --windows \"$JAVA_HOME\")\n [ -n \"$CLASSPATH\" ] \\\n && CLASSPATH=$(cygpath --path --windows \"$CLASSPATH\")\n [ -n \"$MAVEN_PROJECTBASEDIR\" ] \\\n && MAVEN_PROJECTBASEDIR=$(cygpath --path --windows \"$MAVEN_PROJECTBASEDIR\")\nfi\n\n# Provide a \"standardized\" way to retrieve the CLI args that will\n# work with both Windows and non-Windows executions.\nMAVEN_CMD_LINE_ARGS=\"$MAVEN_CONFIG $*\"\nexport MAVEN_CMD_LINE_ARGS\n\nWRAPPER_LAUNCHER=org.apache.maven.wrapper.MavenWrapperMain\n\n# shellcheck disable=SC2086 # safe args\nexec \"$JAVACMD\" \\\n $MAVEN_OPTS \\\n $MAVEN_DEBUG_OPTS \\\n -classpath \"$MAVEN_PROJECTBASEDIR/.mvn/wrapper/maven-wrapper.jar\" \\\n \"-Dmaven.multiModuleProjectDirectory=${MAVEN_PROJECTBASEDIR}\" \\\n ${WRAPPER_LAUNCHER} $MAVEN_CONFIG \"$@\"\n" }, { "path": "mvnw.cmd", "content": "@REM ----------------------------------------------------------------------------\r\n@REM Licensed to the Apache Software Foundation (ASF) under one\r\n@REM or more contributor license agreements. See the NOTICE file\r\n@REM distributed with this work for additional information\r\n@REM regarding copyright ownership. The ASF licenses this file\r\n@REM to you under the Apache License, Version 2.0 (the\r\n@REM \"License\"); you may not use this file except in compliance\r\n@REM with the License. You may obtain a copy of the License at\r\n@REM\r\n@REM http://www.apache.org/licenses/LICENSE-2.0\r\n@REM\r\n@REM Unless required by applicable law or agreed to in writing,\r\n@REM software distributed under the License is distributed on an\r\n@REM \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY\r\n@REM KIND, either express or implied. See the License for the\r\n@REM specific language governing permissions and limitations\r\n@REM under the License.\r\n@REM ----------------------------------------------------------------------------\r\n\r\n@REM ----------------------------------------------------------------------------\r\n@REM Apache Maven Wrapper startup batch script, version 3.3.2\r\n@REM\r\n@REM Required ENV vars:\r\n@REM JAVA_HOME - location of a JDK home dir\r\n@REM\r\n@REM Optional ENV vars\r\n@REM MAVEN_BATCH_ECHO - set to 'on' to enable the echoing of the batch commands\r\n@REM MAVEN_BATCH_PAUSE - set to 'on' to wait for a keystroke before ending\r\n@REM MAVEN_OPTS - parameters passed to the Java VM when running Maven\r\n@REM e.g. to debug Maven itself, use\r\n@REM set MAVEN_OPTS=-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=8000\r\n@REM MAVEN_SKIP_RC - flag to disable loading of mavenrc files\r\n@REM ----------------------------------------------------------------------------\r\n\r\n@REM Begin all REM lines with '@' in case MAVEN_BATCH_ECHO is 'on'\r\n@echo off\r\n@REM set title of command window\r\ntitle %0\r\n@REM enable echoing by setting MAVEN_BATCH_ECHO to 'on'\r\n@if \"%MAVEN_BATCH_ECHO%\" == \"on\" echo %MAVEN_BATCH_ECHO%\r\n\r\n@REM set %HOME% to equivalent of $HOME\r\nif \"%HOME%\" == \"\" (set \"HOME=%HOMEDRIVE%%HOMEPATH%\")\r\n\r\n@REM Execute a user defined script before this one\r\nif not \"%MAVEN_SKIP_RC%\" == \"\" goto skipRcPre\r\n@REM check for pre script, once with legacy .bat ending and once with .cmd ending\r\nif exist \"%USERPROFILE%\\mavenrc_pre.bat\" call \"%USERPROFILE%\\mavenrc_pre.bat\" %*\r\nif exist \"%USERPROFILE%\\mavenrc_pre.cmd\" call \"%USERPROFILE%\\mavenrc_pre.cmd\" %*\r\n:skipRcPre\r\n\r\n@setlocal\r\n\r\nset ERROR_CODE=0\r\n\r\n@REM To isolate internal variables from possible post scripts, we use another setlocal\r\n@setlocal\r\n\r\n@REM ==== START VALIDATION ====\r\nif not \"%JAVA_HOME%\" == \"\" goto OkJHome\r\n\r\necho. >&2\r\necho Error: JAVA_HOME not found in your environment. >&2\r\necho Please set the JAVA_HOME variable in your environment to match the >&2\r\necho location of your Java installation. >&2\r\necho. >&2\r\ngoto error\r\n\r\n:OkJHome\r\nif exist \"%JAVA_HOME%\\bin\\java.exe\" goto init\r\n\r\necho. >&2\r\necho Error: JAVA_HOME is set to an invalid directory. >&2\r\necho JAVA_HOME = \"%JAVA_HOME%\" >&2\r\necho Please set the JAVA_HOME variable in your environment to match the >&2\r\necho location of your Java installation. >&2\r\necho. >&2\r\ngoto error\r\n\r\n@REM ==== END VALIDATION ====\r\n\r\n:init\r\n\r\n@REM Find the project base dir, i.e. the directory that contains the folder \".mvn\".\r\n@REM Fallback to current working directory if not found.\r\n\r\nset MAVEN_PROJECTBASEDIR=%MAVEN_BASEDIR%\r\nIF NOT \"%MAVEN_PROJECTBASEDIR%\"==\"\" goto endDetectBaseDir\r\n\r\nset EXEC_DIR=%CD%\r\nset WDIR=%EXEC_DIR%\r\n:findBaseDir\r\nIF EXIST \"%WDIR%\"\\.mvn goto baseDirFound\r\ncd ..\r\nIF \"%WDIR%\"==\"%CD%\" goto baseDirNotFound\r\nset WDIR=%CD%\r\ngoto findBaseDir\r\n\r\n:baseDirFound\r\nset MAVEN_PROJECTBASEDIR=%WDIR%\r\ncd \"%EXEC_DIR%\"\r\ngoto endDetectBaseDir\r\n\r\n:baseDirNotFound\r\nset MAVEN_PROJECTBASEDIR=%EXEC_DIR%\r\ncd \"%EXEC_DIR%\"\r\n\r\n:endDetectBaseDir\r\n\r\nIF NOT EXIST \"%MAVEN_PROJECTBASEDIR%\\.mvn\\jvm.config\" goto endReadAdditionalConfig\r\n\r\n@setlocal EnableExtensions EnableDelayedExpansion\r\nfor /F \"usebackq delims=\" %%a in (\"%MAVEN_PROJECTBASEDIR%\\.mvn\\jvm.config\") do set JVM_CONFIG_MAVEN_PROPS=!JVM_CONFIG_MAVEN_PROPS! %%a\r\n@endlocal & set JVM_CONFIG_MAVEN_PROPS=%JVM_CONFIG_MAVEN_PROPS%\r\n\r\n:endReadAdditionalConfig\r\n\r\nSET MAVEN_JAVA_EXE=\"%JAVA_HOME%\\bin\\java.exe\"\r\nset WRAPPER_JAR=\"%MAVEN_PROJECTBASEDIR%\\.mvn\\wrapper\\maven-wrapper.jar\"\r\nset WRAPPER_LAUNCHER=org.apache.maven.wrapper.MavenWrapperMain\r\n\r\nset WRAPPER_URL=\"https://repo.maven.apache.org/maven2/org/apache/maven/wrapper/maven-wrapper/3.3.2/maven-wrapper-3.3.2.jar\"\r\n\r\nFOR /F \"usebackq tokens=1,2 delims==\" %%A IN (\"%MAVEN_PROJECTBASEDIR%\\.mvn\\wrapper\\maven-wrapper.properties\") DO (\r\n IF \"%%A\"==\"wrapperUrl\" SET WRAPPER_URL=%%B\r\n)\r\n\r\n@REM Extension to allow automatically downloading the maven-wrapper.jar from Maven-central\r\n@REM This allows using the maven wrapper in projects that prohibit checking in binary data.\r\nif exist %WRAPPER_JAR% (\r\n if \"%MVNW_VERBOSE%\" == \"true\" (\r\n echo Found %WRAPPER_JAR%\r\n )\r\n) else (\r\n if not \"%MVNW_REPOURL%\" == \"\" (\r\n SET WRAPPER_URL=\"%MVNW_REPOURL%/org/apache/maven/wrapper/maven-wrapper/3.3.2/maven-wrapper-3.3.2.jar\"\r\n )\r\n if \"%MVNW_VERBOSE%\" == \"true\" (\r\n echo Couldn't find %WRAPPER_JAR%, downloading it ...\r\n echo Downloading from: %WRAPPER_URL%\r\n )\r\n\r\n powershell -Command \"&{\"^\r\n\t\t\"$webclient = new-object System.Net.WebClient;\"^\r\n\t\t\"if (-not ([string]::IsNullOrEmpty('%MVNW_USERNAME%') -and [string]::IsNullOrEmpty('%MVNW_PASSWORD%'))) {\"^\r\n\t\t\"$webclient.Credentials = new-object System.Net.NetworkCredential('%MVNW_USERNAME%', '%MVNW_PASSWORD%');\"^\r\n\t\t\"}\"^\r\n\t\t\"[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12; $webclient.DownloadFile('%WRAPPER_URL%', '%WRAPPER_JAR%')\"^\r\n\t\t\"}\"\r\n if \"%MVNW_VERBOSE%\" == \"true\" (\r\n echo Finished downloading %WRAPPER_JAR%\r\n )\r\n)\r\n@REM End of extension\r\n\r\n@REM If specified, validate the SHA-256 sum of the Maven wrapper jar file\r\nSET WRAPPER_SHA_256_SUM=\"\"\r\nFOR /F \"usebackq tokens=1,2 delims==\" %%A IN (\"%MAVEN_PROJECTBASEDIR%\\.mvn\\wrapper\\maven-wrapper.properties\") DO (\r\n IF \"%%A\"==\"wrapperSha256Sum\" SET WRAPPER_SHA_256_SUM=%%B\r\n)\r\nIF NOT %WRAPPER_SHA_256_SUM%==\"\" (\r\n powershell -Command \"&{\"^\r\n \"Import-Module $PSHOME\\Modules\\Microsoft.PowerShell.Utility -Function Get-FileHash;\"^\r\n \"$hash = (Get-FileHash \\\"%WRAPPER_JAR%\\\" -Algorithm SHA256).Hash.ToLower();\"^\r\n \"If('%WRAPPER_SHA_256_SUM%' -ne $hash){\"^\r\n \" Write-Error 'Error: Failed to validate Maven wrapper SHA-256, your Maven wrapper might be compromised.';\"^\r\n \" Write-Error 'Investigate or delete %WRAPPER_JAR% to attempt a clean download.';\"^\r\n \" Write-Error 'If you updated your Maven version, you need to update the specified wrapperSha256Sum property.';\"^\r\n \" exit 1;\"^\r\n \"}\"^\r\n \"}\"\r\n if ERRORLEVEL 1 goto error\r\n)\r\n\r\n@REM Provide a \"standardized\" way to retrieve the CLI args that will\r\n@REM work with both Windows and non-Windows executions.\r\nset MAVEN_CMD_LINE_ARGS=%*\r\n\r\n%MAVEN_JAVA_EXE% ^\r\n %JVM_CONFIG_MAVEN_PROPS% ^\r\n %MAVEN_OPTS% ^\r\n %MAVEN_DEBUG_OPTS% ^\r\n -classpath %WRAPPER_JAR% ^\r\n \"-Dmaven.multiModuleProjectDirectory=%MAVEN_PROJECTBASEDIR%\" ^\r\n %WRAPPER_LAUNCHER% %MAVEN_CONFIG% %*\r\nif ERRORLEVEL 1 goto error\r\ngoto end\r\n\r\n:error\r\nset ERROR_CODE=1\r\n\r\n:end\r\n@endlocal & set ERROR_CODE=%ERROR_CODE%\r\n\r\nif not \"%MAVEN_SKIP_RC%\"==\"\" goto skipRcPost\r\n@REM check for post script, once with legacy .bat ending and once with .cmd ending\r\nif exist \"%USERPROFILE%\\mavenrc_post.bat\" call \"%USERPROFILE%\\mavenrc_post.bat\"\r\nif exist \"%USERPROFILE%\\mavenrc_post.cmd\" call \"%USERPROFILE%\\mavenrc_post.cmd\"\r\n:skipRcPost\r\n\r\n@REM pause the script if MAVEN_BATCH_PAUSE is set to 'on'\r\nif \"%MAVEN_BATCH_PAUSE%\"==\"on\" pause\r\n\r\nif \"%MAVEN_TERMINATE_CMD%\"==\"on\" exit %ERROR_CODE%\r\n\r\ncmd /C exit /B %ERROR_CODE%\r\n" }, { "path": "pom.xml", "content": "\n\n\n 4.0.0\n\n io.zipkin\n zipkin-parent\n 3.6.0-SNAPSHOT\n pom\n\n \n zipkin\n zipkin-tests\n zipkin-junit5\n zipkin-storage\n zipkin-collector\n zipkin-server\n \n\n \n ${project.basedir}\n\n UTF-8\n UTF-8\n UTF-8\n UTF-8\n\n \n 17\n 17\n 17\n 17\n 17\n 17\n\n \n \n 2.42.0\n\n 1.0.0\n\n com.linecorp.armeria\n 1.37.0\n \n 4.2.10.Final\n\n \n 2.21.1\n\n 4.19.0\n 1.16.4\n\n \n 1.3.2\n\n \n 3.5.11\n 6.2.17\n\n \n 3.5.3\n 6.2.1\n 2.0.17\n 1.11.0\n 4.9.10\n\n \n 5.13.4\n 1.13.4\n 5.21.0\n 3.27.7\n 4.3.0\n 1.21.4\n 4.12.0\n 5.6.2\n \n 5.1.0\n 2.13.1\n ${project.build.directory}/test/proto\n\n ${skipTests}\n\n 3.6.0\n 1.2.8\n \n 5.0.0\n 3.7.1\n 6.0.0\n 3.15.0\n \n 3.8.1\n 3.1.2\n 3.5.0\n \n 3.5.1\n 3.1.3\n 3.11.2\n 3.4.2\n 3.1.1\n 3.6.0\n 3.3.1\n 3.5.3\n 1.7.0\n 1.3\n \n\n Zipkin (Parent)\n Zipkin (Parent)\n https://github.com/openzipkin/zipkin\n 2015\n\n \n OpenZipkin\n https://zipkin.io/\n \n\n \n \n The Apache Software License, Version 2.0\n https://www.apache.org/licenses/LICENSE-2.0.txt\n repo\n \n \n\n \n https://github.com/openzipkin/zipkin\n scm:git:https://github.com/openzipkin/zipkin.git\n scm:git:https://github.com/openzipkin/zipkin.git\n HEAD\n \n\n \n \n \n openzipkin\n OpenZipkin Gitter\n https://gitter.im/openzipkin/zipkin\n \n \n\n \n \n ossrh\n https://oss.sonatype.org/content/repositories/snapshots\n \n \n ossrh\n https://oss.sonatype.org/service/local/staging/deploy/maven2/\n \n \n\n \n Github\n https://github.com/openzipkin/zipkin/issues\n \n\n \n \n \n\n \n \n \n org.junit.jupiter\n junit-jupiter\n ${junit-jupiter.version}\n test\n \n \n \n org.junit.jupiter\n junit-jupiter-engine\n ${junit-jupiter.version}\n test\n \n \n org.junit.platform\n junit-platform-launcher\n ${junit-platform-laucher.version}\n test\n \n \n org.assertj\n assertj-core\n ${assertj.version}\n test\n \n\n \n org.mockito\n mockito-junit-jupiter\n ${mockito.version}\n test\n \n \n\n \n \n \n \n \n de.qaware.maven\n go-offline-maven-plugin\n ${go-offline-maven-plugin.version}\n \n \n \n \n com.mycila\n license-maven-plugin-git\n ${license-maven-plugin.version}\n MAIN\n \n \n com.google.errorprone\n error_prone_core\n ${errorprone.version}\n MAIN\n \n \n org.apache.maven.surefire\n surefire-junit-platform\n ${maven-surefire-plugin.version}\n PLUGIN\n \n \n \n \n\n \n maven-compiler-plugin\n ${maven-compiler-plugin.version}\n true\n \n true\n true\n \n \n\n \n \n maven-deploy-plugin\n ${maven-deploy-plugin.version}\n \n\n \n maven-install-plugin\n ${maven-install-plugin.version}\n \n\n \n maven-jar-plugin\n ${maven-jar-plugin.version}\n \n \n \n false\n \n \n \n\n \n maven-release-plugin\n ${maven-release-plugin.version}\n \n false\n release\n true\n @{project.version}\n \n \n\n \n org.sonatype.plugins\n nexus-staging-maven-plugin\n ${nexus-staging-maven-plugin.version}\n \n\n \n org.eclipse.m2e\n lifecycle-mapping\n 1.0.0\n \n \n \n \n \n org.apache.maven.plugins\n maven-compiler-plugin\n [3.7,)\n \n compile\n testCompile\n \n \n \n \n org.eclipse.m2e.jdt.javaConfigurator\n \n \n \n \n \n \n \n \n maven-eclipse-plugin\n 2.10\n \n true\n true\n \n \n\n \n maven-shade-plugin\n ${maven-shade-plugin.version}\n \n\n \n \n maven-dependency-plugin\n ${maven-dependency-plugin.version}\n \n \n \n unpack-proto\n generate-sources\n \n unpack-dependencies\n \n \n zipkin-proto3\n **/*.proto\n ${unpack-proto.directory}\n \n \n \n \n \n \n de.m3y.maven\n wire-maven-plugin\n ${wire-maven-plugin.version}\n \n \n generate-sources\n \n generate-sources\n \n \n ${unpack-proto.directory}\n \n zipkin.proto3.*\n \n \n \n \n \n \n \n\n \n \n \n maven-dependency-plugin\n ${maven-dependency-plugin.version}\n \n \n maven-help-plugin\n ${maven-help-plugin.version}\n \n\n \n maven-surefire-plugin\n ${maven-surefire-plugin.version}\n \n \n false\n \n \n \n \n org.junit.jupiter\n junit-jupiter-engine\n ${junit-jupiter.version}\n \n \n \n\n \n maven-failsafe-plugin\n ${maven-surefire-plugin.version}\n \n \n integration-test\n \n integration-test\n \n \n \n verify\n \n verify\n \n \n \n \n \n \n always\n \n \n false\n \n false\n \n \n\n \n maven-enforcer-plugin\n ${maven-enforcer-plugin.version}\n \n \n enforce-java\n \n enforce\n \n \n \n \n \n [17,18),[21,22)\n \n \n \n \n \n \n\n \n com.mycila\n license-maven-plugin\n ${license-maven-plugin.version}\n \n ${license.skip}\n \n
    ${main.basedir}/src/etc/header.txt
    \n \n \n SLASHSTAR_STYLE\n SLASHSTAR_STYLE\n SLASHSTAR_STYLE\n SLASHSTAR_STYLE\n SLASHSTAR_STYLE\n SCRIPT_STYLE\n XML_STYLE\n SLASHSTAR_STYLE\n \n SCRIPT_STYLE\n SCRIPT_STYLE\n \n SCRIPT_STYLE\n SCRIPT_STYLE\n SCRIPT_STYLE\n SCRIPT_STYLE\n SCRIPT_STYLE\n SCRIPT_STYLE\n SCRIPT_STYLE\n SCRIPT_STYLE\n \n SCRIPT_STYLE\n SCRIPT_STYLE\n \n SCRIPT_STYLE\n \n SCRIPT_STYLE\n SCRIPT_STYLE\n SCRIPT_STYLE\n SCRIPT_STYLE\n SCRIPT_STYLE\n SCRIPT_STYLE\n SCRIPT_STYLE\n \n SCRIPT_STYLE\n SCRIPT_STYLE\n SCRIPT_STYLE\n SCRIPT_STYLE\n SCRIPT_STYLE\n SCRIPT_STYLE\n SCRIPT_STYLE\n SCRIPT_STYLE\n \n SCRIPT_STYLE\n \n \n **/simplelogger.properties\n **/continuous-build.yml\n **/*.dockerignore\n .editorconfig\n .gitattributes\n .gitignore\n .github/**\n .mvn/**\n mvnw*\n etc/header.txt\n **/nginx.conf\n **/.idea/**\n **/node_modules/**\n **/build/**\n **/dist/**\n **/coverage/**\n **/.babelrc\n **/.bowerrc\n **/.editorconfig\n **/.env.development\n **/.eslintignore\n **/.eslintrc\n **/.eslintrc\n **/.eslintrc.js\n **/.linguirc\n **/testdata/**/*.json\n **/test/data/**/*.json\n **/src/translations/**\n LICENSE\n **/*.md\n **/*.bnd\n **/src/main/resources/zipkin.txt\n **/src/main/resources/*.yml\n **/spring.factories\n \n **/src/main/resources/*.cql\n kafka_*/**\n **/nohup.out\n src/test/resources/**\n **/generated/**\n .dockerignore\n \n build-bin/configure_deploy\n build-bin/configure_test\n build-bin/deploy\n build-bin/test\n \n true\n     \n \n \n com.mycila\n license-maven-plugin-git\n ${license-maven-plugin.version}\n \n \n \n \n \n check\n \n compile\n \n \n     \n     \n     \n\n \n \n include-lens\n \n \n !skipLens\n \n \n \n zipkin-lens\n \n \n\n \n \n include-benchmarks\n \n \n !skipTests\n \n \n \n benchmarks\n \n \n\n \n error-prone-17+\n \n \n [17,18),[21,22)\n \n \n \n \n maven-compiler-plugin\n ${maven-compiler-plugin.version}\n true\n \n true\n true\n \n \n \n \n default-compile\n compile\n \n compile\n \n \n true\n \n -XDcompilePolicy=simple\n --should-stop=ifError=FLOW\n -Xplugin:ErrorProne ${errorprone.args}\n \n -J--add-exports=jdk.compiler/com.sun.tools.javac.api=ALL-UNNAMED\n -J--add-exports=jdk.compiler/com.sun.tools.javac.file=ALL-UNNAMED\n -J--add-exports=jdk.compiler/com.sun.tools.javac.main=ALL-UNNAMED\n -J--add-exports=jdk.compiler/com.sun.tools.javac.model=ALL-UNNAMED\n -J--add-exports=jdk.compiler/com.sun.tools.javac.parser=ALL-UNNAMED\n -J--add-exports=jdk.compiler/com.sun.tools.javac.processing=ALL-UNNAMED\n -J--add-exports=jdk.compiler/com.sun.tools.javac.tree=ALL-UNNAMED\n -J--add-exports=jdk.compiler/com.sun.tools.javac.util=ALL-UNNAMED\n -J--add-opens=jdk.compiler/com.sun.tools.javac.code=ALL-UNNAMED\n -J--add-opens=jdk.compiler/com.sun.tools.javac.comp=ALL-UNNAMED\n \n \n \n com.google.errorprone\n error_prone_core\n ${errorprone.version}\n \n \n \n com.google.auto.value\n auto-value\n ${auto-value.version}\n \n \n \n \n \n \n \n \n \n\n \n release\n \n \n \n org.sonatype.plugins\n nexus-staging-maven-plugin\n true\n \n ossrh\n https://oss.sonatype.org/\n \n 20\n 30\n true\n \n \n\n \n org.apache.maven.plugins\n maven-gpg-plugin\n 3.2.3\n \n \n sign-artifacts\n verify\n \n sign\n \n \n \n --pinentry-mode\n loopback\n \n \n \n \n \n\n \n \n maven-source-plugin\n ${maven-source-plugin.version}\n \n \n attach-sources\n \n jar\n \n \n \n \n\n \n \n maven-javadoc-plugin\n ${maven-javadoc-plugin.version}\n \n \n **/internal/*.java\n **/Internal*.java\n \n *.internal.*\n false\n \n none\n \n ${maven.compiler.release}\n \n \n \n attach-javadocs\n \n jar\n \n package\n \n \n \n \n \n \n\n \n netbeans\n \n true\n \n \n \n project\n 2\n 2\n 2\n 110\n true\n \n \n\n \n module-info\n \n \n \n bnd.bnd\n \n \n \n \n \n \n org.apache.felix\n maven-bundle-plugin\n ${maven-bundle-plugin.version}\n \n NONE\n \n <_include>-bnd.bnd\n \n \n \n \n process-classes\n \n manifest\n \n \n \n \n \n maven-jar-plugin\n \n \n default-jar\n \n \n \n ${project.build.outputDirectory}/META-INF/MANIFEST.MF\n \n ${module.name}\n \n \n \n \n jar\n \n \n \n \n \n \n \n \n    \n" }, { "path": "src/etc/header.txt", "content": "Copyright The OpenZipkin Authors\nSPDX-License-Identifier: Apache-2.0\n" }, { "path": "zipkin/RATIONALE.md", "content": "Zipkin Core Library Rationale\n==============\n\nMuch of this rationale is the same as [Brave](https://github.com/openzipkin/brave/blob/master/brave/RATIONALE.md), for consistency reasons. Some\naspects, such as Java language level, directly support older versions of Brave.\nHowever, looking only at Brave will not give a full impact of choices here.\nThis library is used for streaming pipelines and other instrumentation\nlibraries. It is important to consider carefully before revisiting topics here.\n\nWhile many ideas are our own, there are notable aspects borrowed or adapted\nfrom others. It is our goal to cite when we learned something through a prior\nlibrary, as that allows people to research any rationale that predates our\nusage.\n\nBelow is always incomplete, and always improvable. We don't document every\nthought as it would betray productivity and make this document unreadable.\nRationale here should be limited to impactful designs, and aspects non-obvious,\nnon-conventional or subtle.\n\n## Java conventions\nWe only expose types public internally or after significant demand. This keeps\nthe api small and easier to manage when charting migration paths. Otherwise,\ntypes are always package private.\n\nMethods should only be marked public when they are intentional apis or\ninheritance requires it. This practice prevents accidental dependence on\nutilities.\n\n### Why no private symbols? (methods and fields)\nZipkin is a library with embedded use cases, such as inside Java agents or\nAndroid code.\n\n\nFor example, Android has a [hard limit on total methods in an application](https://developer.android.com/build/multidex#avoid).\nFields marked private imply accessors in order to share state in the same\npackage. We routinely share state, such as codec internals within a package.\nIf we marked fields private, we'd count against that limit without adding\nvalue.\n\nModifiers on fields and methods are distracting to read and increase the size\nof the bytecode generated during compilation. By recovering the size otherwise\nspent on private modifiers, we not only avoid hitting limits, but we are also\nable to add more code with the same jar size.\n\nFor example, Zipkin 2.21 remains less than 250KiB, with no dependencies,\nincluding an in-memory storage implementation and embedded JSON, ProtoBuf and\nThrift codecs.\n\nThis means we do not support sharing our packages with third parties, but we\ndo support an \"always share inside a package\" in our repository. In other\nwords, we trust our developers to proceed with caution. In the first seven\nyears of project history, we have had no issues raised with this policy.\n\n### Java 8\n\nUp until Zipkin 3, we supported instrumentation of very old applications via\nsource level 1.6. Since then, Brave embedded its own JSON writer and no longer\nuses this library. Also, other instrumentation libraries, like OpenTelemetry,\nhave a floor version of Java 8. Keeping Java 6 support here limits the LTS\nwe can use to release to max JDK 11. We moved to Java 8 to compromise on these\npoints, knowing Brave 6 can still serve old applications.\n\n### Zero dependency policy\nSome dependents of this library are instrumentation in nature, and we cannot\npredict what 3rd party dependencies they will have. Attempting to do that would\nlimit the applicability of this library, which is an anti-goal. Instead, we\nchoose to use nothing except floor Java version features, currently Java 6.\n\nHere's an example of when things that seem right aren't. We once dropped our\ninternal `@Nullable` annotation (which is source retention), in favor of JSR\n305 (which is runtime retention). In doing so, we got `null` analysis from\nIntellij. However, we entered a swamp of dependency conflicts, which started\nwith OSGi (making us switch to a service mix bundle for the annotations), and\nlater Java 9 (conflict with apps using jax-ws). In summary, it is easiest for\nus to have no dependencies also, as we don't inherit tug-of-war between modular\nframeworks who each have a different \"right\" answer for even annotations!\n\nIncidentally, IntelliJ can be configured to use `zipkin2.internal.Nullable`, now.\nSearch for `Nullable` under inspections to configure this.\n\n### Why `new NullPointerException(\"xxx == null\")`\nFor public entry points, we eagerly check null and throw `NullPointerException`\nwith a message like \"xxx == null\". This is not a normal pre-condition, such as\nargument validation, which you'd throw `IllegalArgumentException` for. What's\nhappening here is we are making debugging (literally NPEs are bugs) easier, by\nnot deferring to Java to raise the NPE. If we deferred, it could be confusing\nwhich local was null, especially as deferring results in an exception with no\nmessage.\n\n" }, { "path": "zipkin/bnd.bnd", "content": "# we block import of shaded packages as maven bundle plugin analyzes the unshaded jar\nImport-Package: \\\n\t!com.google.gson.stream,\\\n\t*\nExport-Package: \\\n\tzipkin2,\\\n\tzipkin2.codec,\\\n\tzipkin2.storage,\\\n\tzipkin2.v1,\\\n\tzipkin2.internal;zipkin2internal=true;mandatory:=zipkin2internal\n" }, { "path": "zipkin/pom.xml", "content": "\n\n\n 4.0.0\n\n \n io.zipkin\n zipkin-parent\n 3.6.0-SNAPSHOT\n \n\n io.zipkin.zipkin2\n zipkin\n Zipkin Core Library\n\n \n \n zipkin2\n\n \n -Xep:MutablePublicArray:OFF -Xep:JdkObsolete:OFF\n\n ${project.basedir}/..\n\n 8\n 8\n 8\n \n\n \n \n \n com.google.code.gson\n gson\n ${gson.version}\n \n true\n \n\n \n com.esotericsoftware\n kryo\n ${kryo.version}\n test\n \n \n\n \n \n \n \n maven-shade-plugin\n \n \n package\n \n shade\n \n \n false\n true\n \n \n com.google.code.gson:gson\n \n com/google/gson/Strictness.class\n com/google/gson/stream/JsonReader*.class\n com/google/gson/stream/JsonToken.class\n com/google/gson/stream/MalformedJsonException.class\n com/google/gson/internal/JsonReaderInternalAccess.class\n com/google/gson/internal/TroubleshootingGuide.class\n \n \n \n \n \n com.google.gson\n zipkin2.internal.gson\n \n \n \n \n \n ${module.name}\n \n \n \n \n \n \n \n \n\n \n \n \n false\n ${main.basedir}\n META-INF/\n \n LICENSE\n NOTICE\n \n \n \n \n\n" }, { "path": "zipkin/src/main/java/zipkin2/Annotation.java", "content": "/*\n * Copyright The OpenZipkin Authors\n * SPDX-License-Identifier: Apache-2.0\n */\npackage zipkin2;\n\nimport java.io.ObjectStreamException;\nimport java.io.Serializable;\nimport java.io.StreamCorruptedException;\n\n/**\n * Associates an event that explains latency with a timestamp.\n *\n *

    Unlike log statements, annotations are often codes: Ex. {@code cache.miss}.\n */\n//@Immutable\npublic final class Annotation implements Comparable, Serializable { // for Spark jobs\n private static final long serialVersionUID = 0L;\n\n public static Annotation create(long timestamp, String value) {\n if (value == null) throw new NullPointerException(\"value == null\");\n return new Annotation(timestamp, value);\n }\n\n /**\n * Microseconds from epoch.\n *\n *

    This value should be set directly by instrumentation, using the most precise value possible.\n * For example, {@code gettimeofday} or multiplying {@link System#currentTimeMillis} by 1000.\n */\n public long timestamp() {\n return timestamp;\n }\n\n /**\n * Usually a short tag indicating an event, like {@code cache.miss} or {@code error}\n */\n public String value() {\n return value;\n }\n\n\n /** Compares by {@link #timestamp}, then {@link #value}. */\n @Override public int compareTo(Annotation that) {\n if (this == that) return 0;\n int byTimestamp = timestamp() < that.timestamp() ? -1 : timestamp() == that.timestamp() ? 0 : 1;\n if (byTimestamp != 0) return byTimestamp;\n return value().compareTo(that.value());\n }\n\n // clutter below mainly due to difficulty working with Kryo which cannot handle AutoValue subclass\n // See https://github.com/openzipkin/zipkin/issues/1879\n final long timestamp;\n final String value;\n\n Annotation(long timestamp, String value) {\n this.timestamp = timestamp;\n this.value = value;\n }\n\n @Override public String toString() {\n return \"Annotation{\"\n + \"timestamp=\" + timestamp + \", \"\n + \"value=\" + value\n + \"}\";\n }\n\n @Override public boolean equals(Object o) {\n if (o == this) return true;\n if (!(o instanceof Annotation)) return false;\n Annotation that = (Annotation) o;\n return timestamp == that.timestamp() && value.equals(that.value());\n }\n\n @Override public int hashCode() {\n int h = 1;\n h *= 1000003;\n h ^= (int) ((timestamp >>> 32) ^ timestamp);\n h *= 1000003;\n h ^= value.hashCode();\n return h;\n }\n\n // As this is an immutable object (no default constructor), defer to a serialization proxy.\n Object writeReplace() throws ObjectStreamException {\n return new SerializedForm(this);\n }\n\n private static final class SerializedForm implements Serializable {\n static final long serialVersionUID = 0L;\n\n final long timestamp;\n final String value;\n\n SerializedForm(Annotation annotation) {\n timestamp = annotation.timestamp;\n value = annotation.value;\n }\n\n Object readResolve() throws ObjectStreamException {\n try {\n return Annotation.create(timestamp, value);\n } catch (IllegalArgumentException e) {\n throw new StreamCorruptedException(e.getMessage());\n }\n }\n }\n}\n" }, { "path": "zipkin/src/main/java/zipkin2/Call.java", "content": "/*\n * Copyright The OpenZipkin Authors\n * SPDX-License-Identifier: Apache-2.0\n */\npackage zipkin2;\n\nimport java.io.IOException;\nimport java.util.Collections;\nimport java.util.List;\nimport java.util.Objects;\nimport java.util.concurrent.atomic.AtomicReference;\n\n/**\n * This captures a (usually remote) request and can be used once, either {@link #execute()\n * synchronously} or {@link #enqueue(Callback) asynchronously}. At any time, from any thread, you\n * can call {@linkplain #cancel()}, which might stop an in-flight request or prevent one from\n * occurring.\n *\n *

    Implementations should prepare a call such that there's little or no likelihood of late\n * runtime exceptions. For example, if the call is to get a trace, the call to {@code listSpans}\n * should propagate input errors vs delay them until a call to {@linkplain #execute()} or\n * {@linkplain #enqueue(Callback)}.\n *\n *

    Ex.\n * 

    {@code\n * // Any translation of an input request to remote parameters should happen here, and any related\n * // errors should propagate here.\n * Call>> listTraces = spanStore.listTraces(request);\n * // When this executes, it should simply run the remote request.\n * List trace = getTraceCall.execute();\n * }
    \n *\n *

    An instance of call cannot be invoked more than once, but you can {@linkplain #clone()} an\n * instance if you need to replay the call. There is no relationship between a call and a number of\n * remote requests. For example, an implementation that stores spans may make hundreds of remote\n * requests, possibly retrying on your behalf.\n *\n *

    This type owes its design to {@code retrofit2.Call}, which is nearly the same, except limited\n * to HTTP transports.\n *\n * @param the success type, typically not null except when {@code V} is {@linkplain Void}.\n */\npublic abstract class Call implements Cloneable {\n /**\n * Returns a completed call which has the supplied value. This is useful when input parameters\n * imply there's no call needed. For example, an empty input might always result in an empty\n * output.\n */\n public static Call create(V v) {\n return new Constant<>(v);\n }\n\n @SuppressWarnings(\"unchecked\")\n public static Call> emptyList() {\n return Call.create(Collections.emptyList());\n }\n\n public interface Mapper {\n V2 map(V1 input);\n }\n\n /**\n * Maps the result of this call into a different shape, as defined by the {@code mapper} function.\n * This is used to convert values from one type to another. For example, you could use this to\n * convert between zipkin v1 and v2 span format.\n *\n * 

    {@code\n   * getTracesV1Call = getTracesV2Call.map(traces -> v2TracesConverter);\n   * }
    \n *\n *

    This method intends to be used for chaining. That means \"this\" instance should be discarded\n * in favor of the result of this method.\n */\n public final Call map(Mapper mapper) {\n return new Mapping<>(mapper, this);\n }\n\n public interface FlatMapper {\n Call map(V1 input);\n }\n\n /**\n * Maps the result of this call into another, as defined by the {@code flatMapper} function. This\n * is used to chain two remote calls together. For example, you could use this to chain a list IDs\n * call to a get by IDs call.\n *\n * 

    {@code\n   * getTracesCall = getIdsCall.flatMap(ids -> getTraces(ids));\n   *\n   * // this would now invoke the chain\n   * traces = getTracesCall.enqueue(tracesCallback);\n   * }
    \n *\n * Cancelation propagates to the mapped call.\n *\n *

    This method intends to be used for chaining. That means \"this\" instance should be discarded\n * in favor of the result of this method.\n */\n public final Call flatMap(FlatMapper flatMapper) {\n return new FlatMapping<>(flatMapper, this);\n }\n\n public interface ErrorHandler {\n /** Attempts to resolve an error. The user must call the callback. */\n void onErrorReturn(Throwable error, Callback callback);\n }\n\n /**\n * Returns a call which can attempt to resolve an exception. This is useful when a remote call\n * returns an error when a resource is not found.\n *\n *

    Here's an example of coercing 404 to empty:\n * 

    {@code\n   * call.handleError((error, callback) -> {\n   *   if (error instanceof HttpException && ((HttpException) error).code == 404) {\n   *     callback.onSuccess(Collections.emptyList());\n   *   } else {\n   *     callback.onError(error);\n   *   }\n   * });\n   * }
    \n */\n public final Call handleError(ErrorHandler errorHandler) {\n return new ErrorHandling<>(errorHandler, this);\n }\n\n // Taken from RxJava throwIfFatal, which was taken from scala\n public static void propagateIfFatal(Throwable t) {\n if (t instanceof VirtualMachineError) {\n throw (VirtualMachineError) t;\n } else if (t instanceof ThreadDeath) {\n throw (ThreadDeath) t;\n } else if (t instanceof LinkageError) {\n throw (LinkageError) t;\n }\n }\n\n /**\n * Invokes a request, returning a success value or propagating an error to the caller. Invoking\n * this more than once will result in an error. To repeat a call, make a copy with {@linkplain\n * #clone()}.\n *\n *

    Eventhough this is a blocking call, implementations may honor calls to {@linkplain\n * #cancel()} from a different thread.\n *\n * @return a success value. Null is unexpected, except when {@code V} is {@linkplain Void}.\n */\n public abstract V execute() throws IOException;\n\n /**\n * Invokes a request asynchronously, signaling the {@code callback} when complete. Invoking this\n * more than once will result in an error. To repeat a call, make a copy with {@linkplain\n * #clone()}.\n */\n public abstract void enqueue(Callback callback);\n\n /**\n * Requests to cancel this call, even if some implementations may not support it. For example, a\n * blocking call is sometimes not cancelable.\n */\n // Boolean isn't returned because some implementations may cancel asynchronously.\n // Implementing might throw an IOException on execute or callback.onError(IOException)\n public abstract void cancel();\n\n /**\n * Returns true if {@linkplain #cancel()} was called.\n *\n *

    Calls can fail before being canceled, so true does always mean cancelation caused a call to\n * fail. That said, successful cancellation does result in a failure.\n */\n // isCanceled exists while isExecuted does not because you do not need the latter to implement\n // asynchronous bindings, such as rxjava2\n public abstract boolean isCanceled();\n\n /** Returns a copy of this object, so you can make an identical follow-up request. */\n @Override public abstract Call clone();\n\n static class Constant extends Base { // not final for mock testing\n final V v;\n\n Constant(V v) {\n this.v = v;\n }\n\n @Override protected V doExecute() {\n return v;\n }\n\n @Override protected void doEnqueue(Callback callback) {\n callback.onSuccess(v);\n }\n\n @Override public Call clone() {\n return new Constant<>(v);\n }\n\n @Override public String toString() {\n return \"ConstantCall{value=\" + v + \"}\";\n }\n\n @Override public boolean equals(Object o) {\n if (o == this) return true;\n if (o instanceof Constant) {\n Constant that = (Constant) o;\n return Objects.equals(this.v, that.v);\n }\n return false;\n }\n\n @Override\n public int hashCode() {\n int h = 1;\n h *= 1000003;\n h ^= (v == null) ? 0 : v.hashCode();\n return h;\n }\n }\n\n static final class Mapping extends Base {\n final Mapper mapper;\n final Call delegate;\n\n Mapping(Mapper mapper, Call delegate) {\n this.mapper = mapper;\n this.delegate = delegate;\n }\n\n @Override protected R doExecute() throws IOException {\n return mapper.map(delegate.execute());\n }\n\n @Override protected void doEnqueue(final Callback callback) {\n delegate.enqueue(new Callback() {\n @Override public void onSuccess(V value) {\n try {\n callback.onSuccess(mapper.map(value));\n } catch (Throwable t) {\n callback.onError(t);\n }\n }\n\n @Override public void onError(Throwable t) {\n callback.onError(t);\n }\n });\n }\n\n @Override public String toString() {\n return \"Mapping{call=\" + delegate + \", mapper=\" + mapper + \"}\";\n }\n\n @Override public Call clone() {\n return new Mapping<>(mapper, delegate.clone());\n }\n }\n\n static final class FlatMapping extends Base {\n final FlatMapper flatMapper;\n final Call delegate;\n volatile Call mapped;\n\n FlatMapping(FlatMapper flatMapper, Call delegate) {\n this.flatMapper = flatMapper;\n this.delegate = delegate;\n }\n\n @Override protected R doExecute() throws IOException {\n return (mapped = flatMapper.map(delegate.execute())).execute();\n }\n\n @Override protected void doEnqueue(final Callback callback) {\n delegate.enqueue(new Callback() {\n @Override public void onSuccess(V value) {\n try {\n (mapped = flatMapper.map(value)).enqueue(callback);\n } catch (Throwable t) {\n propagateIfFatal(t);\n callback.onError(t);\n }\n }\n\n @Override public void onError(Throwable t) {\n callback.onError(t);\n }\n });\n }\n\n @Override protected void doCancel() {\n delegate.cancel();\n if (mapped != null) mapped.cancel();\n }\n\n @Override public String toString() {\n return \"FlatMapping{call=\" + delegate + \", flatMapper=\" + flatMapper + \"}\";\n }\n\n @Override public Call clone() {\n return new FlatMapping<>(flatMapper, delegate.clone());\n }\n }\n\n static final class ErrorHandling extends Base {\n static final Object SENTINEL = new Object(); // to differentiate from null\n final ErrorHandler errorHandler;\n final Call delegate;\n\n ErrorHandling(ErrorHandler errorHandler, Call delegate) {\n this.errorHandler = errorHandler;\n this.delegate = delegate;\n }\n\n @Override protected V doExecute() throws IOException {\n try {\n return delegate.execute();\n } catch (IOException e) {\n return handleError(e);\n } catch (RuntimeException e) {\n return handleError(e);\n } catch (Error e) {\n Call.propagateIfFatal(e);\n return handleError(e);\n }\n }\n\n V handleError(T e) throws T {\n final AtomicReference ref = new AtomicReference(SENTINEL);\n errorHandler.onErrorReturn(e, new Callback() {\n @Override\n public void onSuccess(V value) {\n ref.set(value);\n }\n\n @Override\n public void onError(Throwable t) {\n }\n });\n Object result = ref.get();\n if (SENTINEL == result) throw e;\n return (V) result;\n }\n\n @Override protected void doEnqueue(final Callback callback) {\n delegate.enqueue(new Callback() {\n @Override public void onSuccess(V value) {\n callback.onSuccess(value);\n }\n\n @Override public void onError(Throwable t) {\n errorHandler.onErrorReturn(t, callback);\n }\n });\n }\n\n @Override protected void doCancel() {\n delegate.cancel();\n }\n\n @Override public String toString() {\n return \"ErrorHandling{call=\" + delegate + \", errorHandler=\" + errorHandler + \"}\";\n }\n\n @Override public Call clone() {\n return new ErrorHandling<>(errorHandler, delegate.clone());\n }\n }\n\n public static abstract class Base extends Call {\n volatile boolean canceled;\n boolean executed;\n\n protected Base() {\n }\n\n @Override public final V execute() throws IOException {\n synchronized (this) {\n if (this.executed) throw new IllegalStateException(\"Already Executed\");\n this.executed = true;\n }\n\n if (isCanceled()) {\n throw new IOException(\"Canceled\");\n } else {\n return this.doExecute();\n }\n }\n\n protected abstract V doExecute() throws IOException;\n\n @Override public final void enqueue(Callback callback) {\n synchronized (this) {\n if (this.executed) throw new IllegalStateException(\"Already Executed\");\n this.executed = true;\n }\n\n if (isCanceled()) {\n callback.onError(new IOException(\"Canceled\"));\n } else {\n this.doEnqueue(callback);\n }\n }\n\n protected abstract void doEnqueue(Callback callback);\n\n @Override public final void cancel() {\n this.canceled = true;\n doCancel();\n }\n\n protected void doCancel() {\n }\n\n @Override public final boolean isCanceled() {\n return this.canceled || doIsCanceled();\n }\n\n protected boolean doIsCanceled() {\n return false;\n }\n }\n}\n" }, { "path": "zipkin/src/main/java/zipkin2/Callback.java", "content": "/*\n * Copyright The OpenZipkin Authors\n * SPDX-License-Identifier: Apache-2.0\n */\npackage zipkin2;\n\nimport zipkin2.internal.Nullable;\n\n/**\n * A callback of a single result or error.\n *\n *

    This is a bridge to async libraries such as CompletableFuture complete, completeExceptionally.\n *\n *

    Implementations will call either {@link #onSuccess} or {@link #onError}, but not both.\n */\npublic interface Callback {\n\n /**\n * Invoked when computation produces its potentially null value successfully.\n *\n *

    When this is called, {@link #onError} won't be.\n */\n void onSuccess(@Nullable V value);\n\n /**\n * Invoked when computation produces a possibly null value successfully.\n *\n *

    When this is called, {@link #onSuccess} won't be.\n */\n void onError(Throwable t);\n}\n" }, { "path": "zipkin/src/main/java/zipkin2/CheckResult.java", "content": "/*\n * Copyright The OpenZipkin Authors\n * SPDX-License-Identifier: Apache-2.0\n */\npackage zipkin2;\n\nimport zipkin2.internal.Nullable;\n\n/**\n * Answers the question: Are operations on this component likely to succeed?\n *\n *

    Implementations should initialize the component if necessary. It should test a remote\n * connection, or consult a trusted source to derive the result. They should use least resources\n * possible to establish a meaningful result, and be safe to call many times, even concurrently.\n *\n * @see CheckResult#OK\n */\n// @Immutable\npublic final class CheckResult {\n public static final CheckResult OK = new CheckResult(true, null);\n\n public static CheckResult failed(Throwable error) {\n return new CheckResult(false, error);\n }\n\n public boolean ok() {\n return ok;\n }\n\n /** Present when not ok */\n @Nullable\n public Throwable error() {\n return error;\n }\n\n final boolean ok;\n final Throwable error;\n\n CheckResult(boolean ok, @Nullable Throwable error) {\n this.ok = ok;\n this.error = error;\n }\n\n @Override\n public String toString() {\n return \"CheckResult{ok=\" + ok + \", \" + \"error=\" + error + \"}\";\n }\n}\n" }, { "path": "zipkin/src/main/java/zipkin2/Component.java", "content": "/*\n * Copyright The OpenZipkin Authors\n * SPDX-License-Identifier: Apache-2.0\n */\npackage zipkin2;\n\nimport java.io.Closeable;\nimport java.io.IOException;\n\n/**\n * Components are object graphs used to compose a zipkin service or client. For example, a storage\n * component might return a query api.\n *\n *

    Components are lazy with regards to I/O. They can be injected directly to other components so\n * as to avoid crashing the application graph if a network service is unavailable.\n */\npublic abstract class Component implements Closeable {\n\n /**\n * Answers the question: Are operations on this component likely to succeed?\n *\n *

    Implementations should initialize the component if necessary. It should test a remote\n * connection, or consult a trusted source to derive the result. They should use least resources\n * possible to establish a meaningful result, and be safe to call many times, even concurrently.\n *\n * @see CheckResult#OK\n */\n public CheckResult check() {\n return CheckResult.OK;\n }\n\n /**\n * Closes any network resources created implicitly by the component.\n *\n *

    For example, if this created a connection, it would close it. If it was provided one, this\n * would close any sessions, but leave the connection open.\n */\n @Override public void close() throws IOException {\n }\n}\n" }, { "path": "zipkin/src/main/java/zipkin2/DependencyLink.java", "content": "/*\n * Copyright The OpenZipkin Authors\n * SPDX-License-Identifier: Apache-2.0\n */\npackage zipkin2;\n\nimport java.io.ObjectStreamException;\nimport java.io.Serializable;\nimport java.io.StreamCorruptedException;\nimport java.util.Locale;\nimport zipkin2.codec.DependencyLinkBytesDecoder;\nimport zipkin2.codec.DependencyLinkBytesEncoder;\n\nimport static java.nio.charset.StandardCharsets.UTF_8;\n\n/** A dependency link is an edge between two services. */\n//@Immutable\npublic final class DependencyLink implements Serializable { // for Spark and Flink jobs\n private static final long serialVersionUID = 0L;\n\n public static Builder newBuilder() {\n return new Builder();\n }\n\n /** The parent service name (caller), {@link Span#localServiceName()} if instrumented. */\n public String parent() {\n return parent;\n }\n\n /** The chold service name (callee), {@link Span#localServiceName()} if instrumented. */\n public String child() {\n return child;\n }\n\n /** Total traced calls made from {@link #parent} to {@link #child} */\n public long callCount() {\n return callCount;\n }\n\n /**\n * {@linkplain #callCount Count of calls} known to be errors (having one {@linkplain Span#tags()\n * tag} named \"error\").\n */\n public long errorCount() {\n return errorCount;\n }\n\n public Builder toBuilder() {\n return new Builder(this);\n }\n\n public static final class Builder {\n String parent, child;\n long callCount, errorCount;\n\n Builder() {\n }\n\n Builder(DependencyLink source) {\n this.parent = source.parent;\n this.child = source.child;\n this.callCount = source.callCount;\n this.errorCount = source.errorCount;\n }\n\n /** @see #parent() */\n public Builder parent(String parent) {\n if (parent == null) throw new NullPointerException(\"parent == null\");\n this.parent = parent.toLowerCase(Locale.ROOT);\n return this;\n }\n\n /** @see #child() */\n public Builder child(String child) {\n if (child == null) throw new NullPointerException(\"child == null\");\n this.child = child.toLowerCase(Locale.ROOT);\n return this;\n }\n\n /** @see #callCount() */\n public Builder callCount(long callCount) {\n this.callCount = callCount;\n return this;\n }\n\n /** @see #errorCount() */\n public Builder errorCount(long errorCount) {\n this.errorCount = errorCount;\n return this;\n }\n\n public DependencyLink build() {\n String missing = \"\";\n if (parent == null) missing += \" parent\";\n if (child == null) missing += \" child\";\n if (!missing.isEmpty()) throw new IllegalStateException(\"Missing :\" + missing);\n return new DependencyLink(this);\n }\n }\n\n @Override public String toString() {\n return new String(DependencyLinkBytesEncoder.JSON_V1.encode(this), UTF_8);\n }\n\n // clutter below mainly due to difficulty working with Kryo which cannot handle AutoValue subclass\n // See https://github.com/openzipkin/zipkin/issues/1879\n final String parent, child;\n final long callCount, errorCount;\n\n DependencyLink(Builder builder) {\n parent = builder.parent;\n child = builder.child;\n callCount = builder.callCount;\n errorCount = builder.errorCount;\n }\n\n @Override public boolean equals(Object o) {\n if (o == this) return true;\n if (!(o instanceof DependencyLink)) return false;\n DependencyLink that = (DependencyLink) o;\n return parent.equals(that.parent)\n && child.equals(that.child)\n && callCount == that.callCount\n && errorCount == that.errorCount;\n }\n\n @Override public int hashCode() {\n int h = 1;\n h *= 1000003;\n h ^= parent.hashCode();\n h *= 1000003;\n h ^= child.hashCode();\n h *= 1000003;\n h ^= (int) ((callCount >>> 32) ^ callCount);\n h *= 1000003;\n h ^= (int) ((errorCount >>> 32) ^ errorCount);\n return h;\n }\n\n // This is an immutable object, and our encoder is faster than java's: use a serialization proxy.\n Object writeReplace() throws ObjectStreamException {\n return new SerializedForm(DependencyLinkBytesEncoder.JSON_V1.encode(this));\n }\n\n private static final class SerializedForm implements Serializable {\n private static final long serialVersionUID = 0L;\n\n final byte[] bytes;\n\n SerializedForm(byte[] bytes) {\n this.bytes = bytes;\n }\n\n Object readResolve() throws ObjectStreamException {\n try {\n return DependencyLinkBytesDecoder.JSON_V1.decodeOne(bytes);\n } catch (IllegalArgumentException e) {\n throw new StreamCorruptedException(e.getMessage());\n }\n }\n }\n}\n" }, { "path": "zipkin/src/main/java/zipkin2/Endpoint.java", "content": "/*\n * Copyright The OpenZipkin Authors\n * SPDX-License-Identifier: Apache-2.0\n */\npackage zipkin2;\n\nimport java.io.ObjectStreamException;\nimport java.io.Serializable;\nimport java.io.StreamCorruptedException;\nimport java.net.Inet4Address;\nimport java.net.Inet6Address;\nimport java.net.InetAddress;\nimport java.nio.ByteBuffer;\nimport java.util.Locale;\nimport java.util.Objects;\nimport zipkin2.internal.Nullable;\nimport zipkin2.internal.RecyclableBuffers;\n\nimport static zipkin2.internal.HexCodec.HEX_DIGITS;\n\n/** The network context of a node in the service graph. */\n//@Immutable\npublic final class Endpoint implements Serializable { // for Spark and Flink jobs\n private static final long serialVersionUID = 0L;\n\n /**\n * Lower-case label of this node in the service graph, such as \"favstar\". Leave absent if\n * unknown.\n *\n *

    This is a primary label for trace lookup and aggregation, so it should be intuitive and\n * consistent. Many use a name from service discovery.\n */\n @Nullable public String serviceName() {\n return serviceName;\n }\n\n /**\n * The text representation of the primary IPv4 address associated with this a connection. Ex.\n * 192.168.99.100 Absent if unknown.\n */\n @Nullable public String ipv4() {\n return ipv4;\n }\n\n /**\n * IPv4 endpoint address packed into 4 bytes or null if unknown.\n *\n * @see #ipv6()\n * @see java.net.Inet4Address#getAddress()\n */\n @Nullable public byte[] ipv4Bytes() {\n return ipv4Bytes;\n }\n\n /**\n * The text representation of the primary IPv6 address associated with this a connection. Ex.\n * 2001:db8::c001 Absent if unknown.\n *\n * @see #ipv4() for mapped addresses\n * @see #ipv6Bytes()\n */\n @Nullable public String ipv6() {\n return ipv6;\n }\n\n /**\n * IPv6 endpoint address packed into 16 bytes or null if unknown.\n *\n * @see #ipv6()\n * @see java.net.Inet6Address#getAddress()\n */\n @Nullable public byte[] ipv6Bytes() {\n return ipv6Bytes;\n }\n\n /**\n * Port of the IP's socket or null, if not known.\n *\n * @see java.net.InetSocketAddress#getPort()\n */\n @Nullable public Integer port() {\n return port != 0 ? port : null;\n }\n\n /**\n * Like {@link #port()} except returns a primitive where zero implies absent.\n *\n *

    Using this method will avoid allocation, so is encouraged when copying data.\n */\n public int portAsInt() {\n return port;\n }\n\n public Builder toBuilder() {\n return new Builder(this);\n }\n\n public static Builder newBuilder() {\n return new Builder();\n }\n\n public static final class Builder {\n String serviceName, ipv4, ipv6;\n byte[] ipv4Bytes, ipv6Bytes;\n int port; // zero means null\n\n Builder(Endpoint source) {\n serviceName = source.serviceName;\n ipv4 = source.ipv4;\n ipv6 = source.ipv6;\n ipv4Bytes = source.ipv4Bytes;\n ipv6Bytes = source.ipv6Bytes;\n port = source.port;\n }\n\n Builder merge(Endpoint source) {\n if (serviceName == null) serviceName = source.serviceName;\n if (ipv4 == null) ipv4 = source.ipv4;\n if (ipv6 == null) ipv6 = source.ipv6;\n if (ipv4Bytes == null) ipv4Bytes = source.ipv4Bytes;\n if (ipv6Bytes == null) ipv6Bytes = source.ipv6Bytes;\n if (port == 0) port = source.port;\n return this;\n }\n\n /** Sets {@link Endpoint#serviceName} */\n public Builder serviceName(@Nullable String serviceName) {\n this.serviceName = serviceName == null || serviceName.isEmpty()\n ? null : serviceName.toLowerCase(Locale.ROOT);\n return this;\n }\n\n /** Chaining variant of {@link #parseIp(InetAddress)} */\n public Builder ip(@Nullable InetAddress addr) {\n parseIp(addr);\n return this;\n }\n\n /**\n * Returns true if {@link Endpoint#ipv4()} or {@link Endpoint#ipv6()} could be parsed from the\n * input.\n *\n *

    Returns boolean not this for conditional parsing. For example:\n * 

    {@code\n     * if (!builder.parseIp(input.getHeader(\"X-Forwarded-For\"))) {\n     *   builder.parseIp(input.getRemoteAddr());\n     * }\n     * }
    \n *\n * @see #parseIp(String)\n */\n public boolean parseIp(@Nullable InetAddress addr) {\n if (addr == null) return false;\n if (addr instanceof Inet4Address) {\n ipv4 = addr.getHostAddress();\n ipv4Bytes = addr.getAddress();\n } else if (addr instanceof Inet6Address) {\n byte[] addressBytes = addr.getAddress();\n if (!parseEmbeddedIPv4(addressBytes)) {\n ipv6 = writeIpV6(addressBytes);\n ipv6Bytes = addressBytes;\n }\n } else {\n return false;\n }\n return true;\n }\n\n /**\n * Like {@link #parseIp(String)} except this accepts a byte array.\n *\n * @param ipBytes byte array whose ownership is exclusively transferred to this endpoint.\n */\n public boolean parseIp(byte[] ipBytes) {\n if (ipBytes == null) return false;\n if (ipBytes.length == 4) {\n ipv4Bytes = ipBytes;\n ipv4 = writeIpV4(ipBytes);\n } else if (ipBytes.length == 16) {\n if (!parseEmbeddedIPv4(ipBytes)) {\n ipv6 = writeIpV6(ipBytes);\n ipv6Bytes = ipBytes;\n }\n } else {\n return false;\n }\n return true;\n }\n\n static String writeIpV4(byte[] ipBytes) {\n char[] buf = RecyclableBuffers.shortStringBuffer();\n int pos = 0;\n pos = writeBackwards(ipBytes[0] & 0xff, pos, buf);\n buf[pos++] = '.';\n pos = writeBackwards(ipBytes[1] & 0xff, pos, buf);\n buf[pos++] = '.';\n pos = writeBackwards(ipBytes[2] & 0xff, pos, buf);\n buf[pos++] = '.';\n pos = writeBackwards(ipBytes[3] & 0xff, pos, buf);\n return new String(buf, 0, pos);\n }\n\n static int writeBackwards(int b, int pos, char[] buf) {\n if (b < 10) {\n buf[pos] = HEX_DIGITS[b];\n return pos + 1;\n }\n int i = pos += b < 100 ? 2 : 3; // We write backwards from right to left.\n while (b != 0) {\n int digit = b % 10;\n buf[--i] = HEX_DIGITS[digit];\n b /= 10;\n }\n return pos;\n }\n\n /** Chaining variant of {@link #parseIp(String)} */\n public Builder ip(@Nullable String ipString) {\n parseIp(ipString);\n return this;\n }\n\n /**\n * Returns true if {@link Endpoint#ipv4()} or {@link Endpoint#ipv6()} could be parsed from the\n * input.\n *\n *

    Returns boolean not this for conditional parsing. For example:\n * 

    {@code\n     * if (!builder.parseIp(input.getHeader(\"X-Forwarded-For\"))) {\n     *   builder.parseIp(input.getRemoteAddr());\n     * }\n     * }
    \n *\n * @see #parseIp(InetAddress)\n */\n public boolean parseIp(@Nullable String ipString) {\n if (ipString == null || ipString.isEmpty()) return false;\n IpFamily format = detectFamily(ipString);\n if (format == IpFamily.IPv4) {\n ipv4 = ipString;\n ipv4Bytes = getIpv4Bytes(ipv4);\n } else if (format == IpFamily.IPv4Embedded) {\n ipv4 = ipString.substring(ipString.lastIndexOf(':') + 1);\n ipv4Bytes = getIpv4Bytes(ipv4);\n } else if (format == IpFamily.IPv6) {\n byte[] addressBytes = textToNumericFormatV6(ipString);\n if (addressBytes == null) return false;\n ipv6 = writeIpV6(addressBytes); // ensures consistent format\n ipv6Bytes = addressBytes;\n } else {\n return false;\n }\n return true;\n }\n\n /**\n * Use this to set the port to an externally defined value.\n *\n * @param port port associated with the endpoint. zero coerces to null (unknown)\n * @see Endpoint#port()\n */\n public Builder port(@Nullable Integer port) {\n if (port != null) {\n if (port > 0xffff) throw new IllegalArgumentException(\"invalid port \" + port);\n if (port <= 0) port = 0;\n }\n this.port = port != null ? port : 0;\n return this;\n }\n\n /** Sets {@link Endpoint#portAsInt()} */\n public Builder port(int port) {\n if (port > 0xffff) throw new IllegalArgumentException(\"invalid port \" + port);\n if (port < 0) port = 0;\n this.port = port;\n return this;\n }\n\n public Endpoint build() {\n return new Endpoint(this);\n }\n\n Builder() {\n }\n\n boolean parseEmbeddedIPv4(byte[] ipv6) {\n for (int i = 0; i < 10; i++) { // Embedded IPv4 addresses start with unset 80 bits\n if (ipv6[i] != 0) return false;\n }\n\n int flag = (ipv6[10] & 0xff) << 8 | (ipv6[11] & 0xff);\n if (flag != 0) return false; // IPv4-Compatible or IPv4-Mapped\n\n byte o1 = ipv6[12], o2 = ipv6[13], o3 = ipv6[14], o4 = ipv6[15];\n if (o1 == 0 && o2 == 0 && o3 == 0 && o4 == 1) {\n return false; // ::1 is localhost, not an embedded compat address\n }\n\n ipv4 = String.valueOf(o1 & 0xff) + '.' + (o2 & 0xff) + '.' + (o3 & 0xff) + '.' + (o4 & 0xff);\n ipv4Bytes = new byte[] {o1, o2, o3, o4};\n return true;\n }\n }\n\n enum IpFamily {\n Unknown,\n IPv4,\n IPv4Embedded,\n IPv6\n }\n\n /**\n * Adapted from code in {@code com.google.common.net.InetAddresses.ipStringToBytes}. This version\n * separates detection from parsing and checks more carefully about embedded addresses.\n */\n static IpFamily detectFamily(String ipString) {\n boolean hasColon = false;\n boolean hasDot = false;\n for (int i = 0, length = ipString.length(); i < length; i++) {\n char c = ipString.charAt(i);\n if (c == '.') {\n hasDot = true;\n } else if (c == ':') {\n if (hasDot) return IpFamily.Unknown; // Colons must not appear after dots.\n hasColon = true;\n } else if (notHex(c)) {\n return IpFamily.Unknown; // Everything else must be a decimal or hex digit.\n }\n }\n\n // Now decide which address family to parse.\n if (hasColon) {\n if (hasDot) {\n int lastColonIndex = ipString.lastIndexOf(':');\n if (!isValidIpV4Address(ipString, lastColonIndex + 1, ipString.length())) {\n return IpFamily.Unknown;\n }\n if (lastColonIndex == 1 && ipString.charAt(0) == ':') {// compressed like ::1.2.3.4\n return IpFamily.IPv4Embedded;\n }\n if (lastColonIndex != 6 || ipString.charAt(0) != ':' || ipString.charAt(1) != ':') {\n return IpFamily.Unknown;\n }\n for (int i = 2; i < 6; i++) {\n char c = ipString.charAt(i);\n if (c != 'f' && c != 'F' && c != '0') return IpFamily.Unknown;\n }\n return IpFamily.IPv4Embedded;\n }\n return IpFamily.IPv6;\n } else if (hasDot && isValidIpV4Address(ipString, 0, ipString.length())) {\n return IpFamily.IPv4;\n }\n return IpFamily.Unknown;\n }\n\n static boolean notHex(char c) {\n return (c < '0' || c > '9') && (c < 'a' || c > 'f') && (c < 'A' || c > 'F');\n }\n\n static String writeIpV6(byte[] ipv6) {\n int pos = 0;\n char[] buf = RecyclableBuffers.shortStringBuffer();\n\n // Compress the longest string of zeros\n int zeroCompressionIndex = -1;\n int zeroCompressionLength = -1;\n int zeroIndex = -1;\n boolean allZeros = true;\n for (int i = 0; i < ipv6.length; i += 2) {\n if (ipv6[i] == 0 && ipv6[i + 1] == 0) {\n if (zeroIndex < 0) zeroIndex = i;\n continue;\n }\n allZeros = false;\n if (zeroIndex >= 0) {\n int zeroLength = i - zeroIndex;\n if (zeroLength > zeroCompressionLength) {\n zeroCompressionIndex = zeroIndex;\n zeroCompressionLength = zeroLength;\n }\n zeroIndex = -1;\n }\n }\n\n // handle all zeros: 0:0:0:0:0:0:0:0 -> ::\n if (allZeros) return \"::\";\n\n // handle trailing zeros: 2001:0:0:4:0:0:0:0 -> 2001:0:0:4::\n if (zeroCompressionIndex == -1 && zeroIndex != -1) {\n zeroCompressionIndex = zeroIndex;\n zeroCompressionLength = 16 - zeroIndex;\n }\n\n int i = 0;\n while (i < ipv6.length) {\n if (i == zeroCompressionIndex) {\n buf[pos++] = ':';\n i += zeroCompressionLength;\n if (i == ipv6.length) buf[pos++] = ':';\n continue;\n }\n if (i != 0) buf[pos++] = ':';\n\n byte high = ipv6[i++];\n byte low = ipv6[i++];\n\n // handle leading zeros: 2001:0:0:4:0000:0:0:8 -> 2001:0:0:4::8\n boolean leadingZero;\n char val = HEX_DIGITS[(high >> 4) & 0xf];\n if (!(leadingZero = val == '0')) buf[pos++] = val;\n val = HEX_DIGITS[high & 0xf];\n if (!(leadingZero = (leadingZero && val == '0'))) buf[pos++] = val;\n val = HEX_DIGITS[(low >> 4) & 0xf];\n if (!(leadingZero && val == '0')) buf[pos++] = val;\n buf[pos++] = HEX_DIGITS[low & 0xf];\n }\n return new String(buf, 0, pos);\n }\n\n // Begin code from com.google.common.net.InetAddresses 23\n static final int IPV6_PART_COUNT = 8;\n\n @Nullable\n static byte[] textToNumericFormatV6(String ipString) {\n // An address can have [2..8] colons, and N colons make N+1 parts.\n String[] parts = ipString.split(\":\", IPV6_PART_COUNT + 2);\n if (parts.length < 3 || parts.length > IPV6_PART_COUNT + 1) {\n return null;\n }\n\n // Disregarding the endpoints, find \"::\" with nothing in between.\n // This indicates that a run of zeroes has been skipped.\n int skipIndex = -1;\n for (int i = 1; i < parts.length - 1; i++) {\n if (parts[i].isEmpty()) {\n if (skipIndex >= 0) {\n return null; // Can't have more than one ::\n }\n skipIndex = i;\n }\n }\n\n int partsHi; // Number of parts to copy from above/before the \"::\"\n int partsLo; // Number of parts to copy from below/after the \"::\"\n if (skipIndex >= 0) {\n // If we found a \"::\", then check if it also covers the endpoints.\n partsHi = skipIndex;\n partsLo = parts.length - skipIndex - 1;\n if (parts[0].isEmpty() && --partsHi != 0) {\n return null; // ^: requires ^::\n }\n if (parts[parts.length - 1].isEmpty() && --partsLo != 0) {\n return null; // :$ requires ::$\n }\n } else {\n // Otherwise, allocate the entire address to partsHi. The endpoints\n // could still be empty, but parseHextet() will check for that.\n partsHi = parts.length;\n partsLo = 0;\n }\n\n // If we found a ::, then we must have skipped at least one part.\n // Otherwise, we must have exactly the right number of parts.\n int partsSkipped = IPV6_PART_COUNT - (partsHi + partsLo);\n if (!(skipIndex >= 0 ? partsSkipped >= 1 : partsSkipped == 0)) {\n return null;\n }\n\n // Now parse the hextets into a byte array.\n ByteBuffer rawBytes = ByteBuffer.allocate(2 * IPV6_PART_COUNT);\n try {\n for (int i = 0; i < partsHi; i++) {\n rawBytes.putShort(parseHextet(parts[i]));\n }\n for (int i = 0; i < partsSkipped; i++) {\n rawBytes.putShort((short) 0);\n }\n for (int i = partsLo; i > 0; i--) {\n rawBytes.putShort(parseHextet(parts[parts.length - i]));\n }\n } catch (NumberFormatException ex) {\n return null;\n }\n return rawBytes.array();\n }\n\n static short parseHextet(String ipPart) {\n // Note: we already verified that this string contains only hex digits.\n int hextet = Integer.parseInt(ipPart, 16);\n if (hextet > 0xffff) {\n throw new NumberFormatException();\n }\n return (short) hextet;\n }\n // End code from com.google.common.net.InetAddresses 23\n\n // Begin code from io.netty.util.NetUtil 4.1\n static boolean isValidIpV4Address(String ip, int from, int toExcluded) {\n int len = toExcluded - from;\n int i;\n return len <= 15 && len >= 7 &&\n (i = ip.indexOf('.', from + 1)) > 0 && isValidIpV4Word(ip, from, i) &&\n (i = ip.indexOf('.', from = i + 2)) > 0 && isValidIpV4Word(ip, from - 1, i) &&\n (i = ip.indexOf('.', from = i + 2)) > 0 && isValidIpV4Word(ip, from - 1, i) &&\n isValidIpV4Word(ip, i + 1, toExcluded);\n }\n\n static boolean isValidIpV4Word(CharSequence word, int from, int toExclusive) {\n int len = toExclusive - from;\n char c0, c1, c2;\n if (len < 1 || len > 3 || (c0 = word.charAt(from)) < '0') {\n return false;\n }\n if (len == 3) {\n return (c1 = word.charAt(from + 1)) >= '0' &&\n (c2 = word.charAt(from + 2)) >= '0' &&\n ((c0 <= '1' && c1 <= '9' && c2 <= '9') ||\n (c0 == '2' && c1 <= '5' && (c2 <= '5' || (c1 < '5' && c2 <= '9'))));\n }\n return c0 <= '9' && (len == 1 || isValidNumericChar(word.charAt(from + 1)));\n }\n\n static boolean isValidNumericChar(char c) {\n return c >= '0' && c <= '9';\n }\n // End code from io.netty.util.NetUtil 4.1\n\n // clutter below mainly due to difficulty working with Kryo which cannot handle AutoValue subclass\n // See https://github.com/openzipkin/zipkin/issues/1879\n final String serviceName, ipv4, ipv6;\n final byte[] ipv4Bytes, ipv6Bytes;\n final int port;\n\n Endpoint(Builder builder) {\n serviceName = builder.serviceName;\n ipv4 = builder.ipv4;\n ipv4Bytes = builder.ipv4Bytes;\n ipv6 = builder.ipv6;\n ipv6Bytes = builder.ipv6Bytes;\n port = builder.port;\n }\n\n Endpoint(SerializedForm serializedForm) {\n serviceName = serializedForm.serviceName;\n ipv4 = serializedForm.ipv4;\n ipv4Bytes = serializedForm.ipv4Bytes;\n ipv6 = serializedForm.ipv6;\n ipv6Bytes = serializedForm.ipv6Bytes;\n port = serializedForm.port;\n }\n\n @Override public String toString() {\n return \"Endpoint{\"\n + \"serviceName=\" + serviceName + \", \"\n + \"ipv4=\" + ipv4 + \", \"\n + \"ipv6=\" + ipv6 + \", \"\n + \"port=\" + port\n + \"}\";\n }\n\n @Override public boolean equals(Object o) {\n if (o == this) return true;\n if (!(o instanceof Endpoint)) return false;\n Endpoint that = (Endpoint) o;\n return Objects.equals(serviceName, that.serviceName)\n && Objects.equals(ipv4, that.ipv4)\n && Objects.equals(ipv6, that.ipv6)\n && port == that.port;\n }\n\n @Override public int hashCode() {\n int h = 1;\n h *= 1000003;\n h ^= (serviceName == null) ? 0 : serviceName.hashCode();\n h *= 1000003;\n h ^= (ipv4 == null) ? 0 : ipv4.hashCode();\n h *= 1000003;\n h ^= (ipv6 == null) ? 0 : ipv6.hashCode();\n h *= 1000003;\n h ^= port;\n return h;\n }\n\n // As this is an immutable object (no default constructor), defer to a serialization proxy.\n Object writeReplace() throws ObjectStreamException {\n return new SerializedForm(this);\n }\n\n // TODO: replace this with native proto3 encoding\n static final class SerializedForm implements Serializable {\n static final long serialVersionUID = 0L;\n\n final String serviceName, ipv4, ipv6;\n final byte[] ipv4Bytes, ipv6Bytes;\n final int port;\n\n SerializedForm(Endpoint endpoint) {\n serviceName = endpoint.serviceName;\n ipv4 = endpoint.ipv4;\n ipv4Bytes = endpoint.ipv4Bytes;\n ipv6 = endpoint.ipv6;\n ipv6Bytes = endpoint.ipv6Bytes;\n port = endpoint.port;\n }\n\n Object readResolve() throws ObjectStreamException {\n try {\n return new Endpoint(this);\n } catch (IllegalArgumentException e) {\n throw new StreamCorruptedException(e.getMessage());\n }\n }\n }\n\n static byte[] getIpv4Bytes(String ipv4) {\n byte[] result = new byte[4];\n int pos = 0;\n for (int i = 0, len = ipv4.length(); i < len; ) {\n char ch = ipv4.charAt(i++);\n int octet = ch - '0';\n if (i == len || (ch = ipv4.charAt(i++)) == '.') {\n // then we have a single digit octet\n result[pos++] = (byte) octet;\n continue;\n }\n // push the decimal\n octet = (octet * 10) + (ch - '0');\n if (i == len || (ch = ipv4.charAt(i++)) == '.') {\n // then we have a two digit octet\n result[pos++] = (byte) octet;\n continue;\n }\n // otherwise, we have a three digit octet\n octet = (octet * 10) + (ch - '0');\n result[pos++] = (byte) octet;\n i++; // skip the dot\n }\n return result;\n }\n}\n" }, { "path": "zipkin/src/main/java/zipkin2/Span.java", "content": "/*\n * Copyright The OpenZipkin Authors\n * SPDX-License-Identifier: Apache-2.0\n */\npackage zipkin2;\n\nimport java.io.ObjectStreamException;\nimport java.io.Serializable;\nimport java.io.StreamCorruptedException;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Collections;\nimport java.util.LinkedHashMap;\nimport java.util.List;\nimport java.util.Locale;\nimport java.util.Map;\nimport java.util.Objects;\nimport java.util.TreeMap;\nimport java.util.logging.Logger;\nimport zipkin2.codec.SpanBytesDecoder;\nimport zipkin2.codec.SpanBytesEncoder;\nimport zipkin2.internal.Nullable;\nimport zipkin2.internal.RecyclableBuffers;\n\nimport static java.lang.String.format;\nimport static java.nio.charset.StandardCharsets.UTF_8;\nimport static java.util.logging.Level.FINEST;\nimport static zipkin2.internal.HexCodec.HEX_DIGITS;\n\n/**\n * A span is a single-host view of an operation. A trace is a series of spans (often RPC calls)\n * which nest to form a latency tree. Spans are in the same trace when they share the same trace ID.\n * The {@link #parentId} field establishes the position of one span in the tree.\n *\n *

    The root span is where {@link #parentId} is null and usually has the longest {@link\n * #duration} in the trace. However, nested asynchronous work can materialize as child spans whose\n * duration exceed the root span.\n *\n *

    Spans usually represent remote activity such as RPC calls, or messaging producers and\n * consumers. However, they can also represent in-process activity in any position of the trace. For\n * example, a root span could represent a server receiving an initial client request. A root span\n * could also represent a scheduled job that has no remote context.\n *\n *

    While span identifiers are packed into longs, they should be treated opaquely. ID encoding is\n * 16 or 32 character lower-hex, to avoid signed interpretation.\n *\n *

    Relationship to {@code zipkin.Span}

    \n *\n *

    This type is intended to replace use of {@code zipkin.Span}. Particularly, tracers represent\n * a single-host view of an operation. By making one endpoint implicit for all data, this type does\n * not need to repeat endpoints on each data like {@code zipkin.Span} does. This results in simpler\n * and smaller data.\n */\n//@Immutable\npublic final class Span implements Serializable { // for Spark and Flink jobs\n static final Endpoint EMPTY_ENDPOINT = Endpoint.newBuilder().build();\n\n static final int FLAG_DEBUG = 1 << 1;\n static final int FLAG_DEBUG_SET = 1 << 2;\n static final int FLAG_SHARED = 1 << 3;\n static final int FLAG_SHARED_SET = 1 << 4;\n\n private static final long serialVersionUID = 0L;\n\n /**\n * Trace identifier, set on all spans within it.\n *\n *

    Encoded as 16 or 32 lowercase hex characters corresponding to 64 or 128 bits. For example,\n * a 128bit trace ID looks like {@code 4e441824ec2b6a44ffdc9bb9a6453df3}.\n *\n *

    Some systems downgrade trace identifiers to 64bit by dropping the left-most 16 characters.\n * For example, {@code 4e441824ec2b6a44ffdc9bb9a6453df3} becomes {@code ffdc9bb9a6453df3}.\n */\n public String traceId() {\n return traceId;\n }\n\n /**\n * The parent's {@link #id} or null if this the root span in a trace.\n *\n *

    This is the same encoding as {@link #id}. For example {@code ffdc9bb9a6453df3}\n */\n @Nullable public String parentId() {\n return parentId;\n }\n\n /**\n * Unique 64bit identifier for this operation within the trace.\n *\n *

    Encoded as 16 lowercase hex characters. For example {@code ffdc9bb9a6453df3}\n *\n *

    A span is uniquely identified in storage by ({@linkplain #traceId}, {@linkplain #id()}).\n */\n public String id() {\n return id;\n }\n\n /** Indicates the primary span type. */\n public enum Kind {\n CLIENT,\n SERVER,\n /**\n * When present, {@link #timestamp()} is the moment a producer sent a message to a destination.\n * {@link #duration()} represents delay sending the message, such as batching, while {@link\n * #remoteEndpoint()} indicates the destination, such as a broker.\n *\n *

    Unlike {@link #CLIENT}, messaging spans never share a span ID. For example, the {@link\n * #CONSUMER} of the same message has {@link #parentId()} set to this span's {@link #id()}.\n */\n PRODUCER,\n /**\n * When present, {@link #timestamp()} is the moment a consumer received a message from an\n * origin. {@link #duration()} represents delay consuming the message, such as from backlog,\n * while {@link #remoteEndpoint()} indicates the origin, such as a broker.\n *\n *

    Unlike {@link #SERVER}, messaging spans never share a span ID. For example, the {@link\n * #PRODUCER} of this message is the {@link #parentId()} of this span.\n */\n CONSUMER\n }\n\n /** When present, used to interpret {@link #remoteEndpoint} */\n @Nullable public Kind kind() {\n return kind;\n }\n\n /**\n * Span name in lowercase, rpc method for example.\n *\n *

    Conventionally, when the span name isn't known, name = \"unknown\".\n */\n @Nullable public String name() {\n return name;\n }\n\n /**\n * Epoch microseconds of the start of this span, possibly absent if this an incomplete span.\n *\n *

    This value should be set directly by instrumentation, using the most precise value\n * possible. For example, {@code gettimeofday} or multiplying {@link System#currentTimeMillis} by\n * 1000.\n *\n *

    There are three known edge-cases where this could be reported absent:\n *\n * 

      \n   * 
    • A span was allocated but never started (ex not yet received a timestamp)
      • \n   * 
    • The span's start event was lost
      • \n   * 
    • Data about a completed span (ex tags) were sent after the fact
      • \n   *