{"id":18717019,"url":"https://github.com/scouter-project/zipkin-scouter","last_synced_at":"2025-07-30T17:02:45.107Z","repository":{"id":54169289,"uuid":"155078306","full_name":"scouter-project/zipkin-scouter","owner":"scouter-project","description":"Zikpin Scouter UDP storage and other zipkin-scouter integrations.","archived":false,"fork":false,"pushed_at":"2021-03-05T18:16:44.000Z","size":51,"stargazers_count":10,"open_issues_count":3,"forks_count":4,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-07-16T03:25:31.760Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/scouter-project.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-10-28T14:12:08.000Z","updated_at":"2023-12-12T23:38:32.000Z","dependencies_parsed_at":"2022-08-13T08:10:48.628Z","dependency_job_id":null,"html_url":"https://github.com/scouter-project/zipkin-scouter","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/scouter-project/zipkin-scouter","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/scouter-project%2Fzipkin-scouter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/scouter-project%2Fzipkin-scouter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/scouter-project%2Fzipkin-scouter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/scouter-project%2Fzipkin-scouter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/scouter-project","download_url":"https://codeload.github.com/scouter-project/zipkin-scouter/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/scouter-project%2Fzipkin-scouter/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":265677366,"owners_count":23809952,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-07T13:14:32.685Z","updated_at":"2025-07-30T17:02:45.015Z","avatar_url":"https://github.com/scouter-project.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# zipkin-scouter\nZipkin Scouter UDP storage and other zipkin-scouter integrations.\n* Supported scouter collector version : `v2.5+`\n\n## Server integration\nIn order to integrate with zipkin-server, you need to use properties\nlauncher to load your collector (or sender) alongside the zipkin-server\nprocess.\n\nTo integrate a module with a Zipkin server, you need to:\n* add a module jar to the `loader.path`\n* enable the profile associated with that module\n* launch Zipkin with `PropertiesLauncher`\n\nEach module will also have different minimum variables that need to be set.\n\n\n## Example integrating the Scouter Collector by Zipkin-Scouter-Storage\n\nHere's an example of integrating the scouter Collector.\n\n### Step 1: Download zipkin-server jar\nDownload the [latest released server](https://search.maven.org/remote_content?g=io.zipkin\u0026a=zipkin-server\u0026v=2.12.9\u0026c=exec) as zipkin.jar:\n\n```\ncd /tmp\nwget -O zipkin.jar 'https://search.maven.org/remote_content?g=io.zipkin.java\u0026a=zipkin-server\u0026v=2.12.9\u0026c=exec'\n```\n\n### Step 2: Download the latest zipkin-storage-scouter jar\nDownload the [latest released Scouter module](https://search.maven.org/remote_content?g=io.github.scouter-project\u0026a=zipkin-autoconfigure-storage-scouter-udp\u0026v=LATEST\u0026c=module) as zipkin-storage-scouter.jar:\n\n```\ncd /tmp\nwget -O zipkin-storage-scouter.jar 'https://search.maven.org/remote_content?g=io.github.scouter-project\u0026a=zipkin-autoconfigure-storage-scouter-udp\u0026v=LATEST\u0026c=module'\n```\n\n### Step 3: Run the server with the \"scouter\" profile active\nWhen you enable the \"scouter\" profile, you can configure scouter with\nshort environment variables similar to other [Zipkin integrations](https://github.com/openzipkin/zipkin/blob/master/zipkin-server/README.md#elasticsearch-storage).\n\n``` bash\ncd /tmp\nSCOUTER_COLLECTOR_ADDR=127.0.0.1 \\\nSCOUTER_COLLECTOR_PORT=6100 \\\nSCOUTER_SERVICE_MAPS_OJB_TYPE= \\\nSTORAGE_TYPE=scouter \\\njava -Dloader.path='zipkin-storage-scouter.jar,zipkin-storage-scouter.jar!lib' -Dspring.profiles.active=scouter -cp zipkin.jar org.springframework.boot.loader.PropertiesLauncher\n```\n* **NOTE:** Make sure the parameters are defined in the same line or use environment variables **\n\n* Configures\n  * `STORAGE_TYPE=scouter` : **required**. All others are optional.\n  * `SCOUTER_COLLECTOR_ADDR` (default: 127.0.0.1) : Scouter collector IP \n  * `SCOUTER_COLLECTOR_PORT` (default: 6100) : Scounter collector Port\n  * `SCOUTER_UDP_PACKET_MAX_BYTES` (default: 60000) : should be smaller than OS UDP diagram size.  \n  * `SCOUTER_TAG_MAP_TEXT1` : tag mapping to scouter xlog's predefined column `text1` (default: `spring.instance_id`) (comma separated multi-tags supported.)\n  * `SCOUTER_TAG_MAP_TEXT2` : tag mapping to scouter xlog's predefined column `text2` (comma separated multi-tags supported.)\n  * `SCOUTER_TAG_MAP_TEXT3` : tag mapping to scouter xlog's predefined column `text3` (comma separated multi-tags supported.)\n  * `SCOUTER_TAG_MAP_TEXT4` : tag mapping to scouter xlog's predefined column `text4` (comma separated multi-tags supported.)\n  * `SCOUTER_TAG_MAP_TEXT5` : tag mapping to scouter xlog's predefined column `text5` (comma separated multi-tags supported.)\n  * `SCOUTER_TAG_MAP_LOGIN` : tag mapping to scouter xlog's predefined dictionary encoded column `login` (just single first matching tag of comma separated tags is used for the column.)\n  * `SCOUTER_TAG_MAP_DESC` : tag mapping to scouter xlog's predefined dictionary encoded column `desc` (just single first matching tag of comma separated tags is used for the column.)\n  * `SCOUTER_SERVICE_MAPS_OJB_TYPE` : map a zipkin's local endpoint service name to a scouter objType (ex: system1:OrderSystem,system2:CustomerSystem ...). It use the same name of service name with preceding $z.\n  * `SCOUTER_DEBUG` (default: false) : Debug option  \n\n### Limitation\nThis currently only supports sending to a Scouter collector, not reading back spans from the service.  \nSpans can be shown in the Scouter's XLog view.\n\n### Scouter Links\n - [Scouter GitHub](https://github.com/scouter-project/scouter)  \n\n### Scouter Paper Links\n - [Scouter Paper Homepage](https://github.com/scouter-project/scouter)\n - **Scouter Paper showcase** : [scouter paper overview (youtube)](https://www.youtube.com/watch?v=NjJ0dGhdIbU)\n \n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fscouter-project%2Fzipkin-scouter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fscouter-project%2Fzipkin-scouter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fscouter-project%2Fzipkin-scouter/lists"}