{"id":26031761,"url":"https://github.com/apache/skywalking-agent-test-tool","last_synced_at":"2025-04-10T04:42:38.337Z","repository":{"id":41958347,"uuid":"243660063","full_name":"apache/skywalking-agent-test-tool","owner":"apache","description":"The integration test tool for Apache SkyWalking, including Mock OAP server and trace validator.","archived":false,"fork":false,"pushed_at":"2024-03-20T15:19:06.000Z","size":224,"stargazers_count":33,"open_issues_count":0,"forks_count":32,"subscribers_count":35,"default_branch":"master","last_synced_at":"2025-04-03T04:17:06.700Z","etag":null,"topics":["apm","dapper","distributed-tracing","lua","nginx","observability","skywalking","test"],"latest_commit_sha":null,"homepage":"https://skywalking.apache.org/","language":"Java","has_issues":false,"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/apache.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,"governance":null,"roadmap":null,"authors":null}},"created_at":"2020-02-28T02:18:33.000Z","updated_at":"2025-03-20T07:44:01.000Z","dependencies_parsed_at":"2024-01-29T03:57:56.819Z","dependency_job_id":null,"html_url":"https://github.com/apache/skywalking-agent-test-tool","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apache%2Fskywalking-agent-test-tool","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apache%2Fskywalking-agent-test-tool/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apache%2Fskywalking-agent-test-tool/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apache%2Fskywalking-agent-test-tool/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/apache","download_url":"https://codeload.github.com/apache/skywalking-agent-test-tool/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247715042,"owners_count":20983981,"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":["apm","dapper","distributed-tracing","lua","nginx","observability","skywalking","test"],"created_at":"2025-03-06T20:58:45.593Z","updated_at":"2025-04-10T04:42:38.304Z","avatar_url":"https://github.com/apache.png","language":"Java","readme":"Apache SkyWalking Agent Test Tool Suite\n==========\n\n\u003cimg src=\"http://skywalking.apache.org/assets/logo.svg\" alt=\"Sky Walking logo\" height=\"90px\" align=\"right\" /\u003e\n\n[![Twitter Follow](https://img.shields.io/twitter/follow/asfskywalking.svg?style=for-the-badge\u0026label=Follow\u0026logo=twitter)](https://twitter.com/AsfSkyWalking)\n\n![CI](https://github.com/apache/skywalking-agent-test-tool/workflows/CI/badge.svg?branch=master)\n\n\n[**SkyWalking**](https://github.com/apache/skywalking) Agent Test Tool is a tremendously useful test tools suite in a wide variety of languages of `Agent`. \nIncludes `mock collector` and `validator`. The `mock collector` is a SkyWalking receiver, like OAP server. \n\nThe `mock collector` is responsible for mocking the SkyWalking OAP receiver to collect data from the agent. It receives data from agent through `GRPC` and `HTTP REST API`(in plan).\nAnd then it can be downloaded by Http API that the mock collector collected(service registered, instance registered, and segments). \nEventually, validate the file downloaded from `mock collector` by using `SkyWalking Validator`. \n\n## Apache SkyWalking Mock Collector\n\n### Requirement\n1. JDK 1.8+\n2. Maven \n\n\n### How to install\n\nThe `mock collector` is written by pure-`Java`. It compiles and packages through `Maven`.\n\n\n```bash\nmvn package -DskipTests\nunzip ./dist/mock-collector.tar.gz -d ./mock-collector\ncd ./mock-collector\nbash ./bin/collector-startup.sh\n```\n\nafter above steps, we can check whether the `mock collector` is available through HTTP API. To visit `http://localhost:12800/healthCheck` and get the response with `success` in the body of content.\n\nFinally, To visit follow URL to download the data as `yaml` file, which can be used by `SkyWalking Validator Tool`.\n\nhttp://localhost:12800/receiveData\n\n### How to config on agent\n\nWe can modify the configurations of agent in `./config/agent.conf`, as follows\n\n```properties\n# Backend service addresses.\ncollector.backend_service=${SW_AGENT_COLLECTOR_BACKEND_SERVICES:127.0.0.1:19876}\n```\n\nor specify the jvm arguments like:\n\n```bash\n# Backend service addresses.\n-DSW_AGENT_COLLECTOR_BACKEND_SERVICES=127.0.0.1:19876\n```\n\n### Data validation in Mock Collector\n\nCurrently, we integration SkyWalking Validator Tool in Mock Collector. We can post the `expectedData.yaml` to `/dataValidate` after agent reported.\n\n## Apache SkyWalking Validator Tool\n\n`Validator Tool` is a data validating tool. It is responsible for validating the `expected data` with `actual data`.\n\n```bash\njava -jar \\\n    -Xmx256m -Xms256m \\\n    -DcaseName=\"case_name\" \\\n    -DtestCasePath=/path/to/download-folder \\\n    ${TOOLS_HOME}/skywalking-validator-tools.jar\n```\n\nNOTICE: the `expected data` have to call `expectedData.yaml`, and the `actual data` must name as `actualData.yaml`. These files save all the segment and meter data, and in the same directory, `/path/to/download-folder`.\nJVM argument `caseName` just for show in the log.\n\nThe format and documentation of `expectedData.yaml` could be found in [SkyWalking plugin test doc](https://skywalking.apache.org/docs/skywalking-java/next/en/setup/service-agent/java-agent/plugin-test/)\n\n# Contact Us\n* Mail list: **dev@skywalking.apache.org**. Mail to `dev-subscribe@skywalking.apache.org`, follow the reply to subscribe the mail list.\n* Join `skywalking` channel at [Apache Slack](https://join.slack.com/t/the-asf/shared_invite/enQtNzc2ODE3MjI1MDk1LTAyZGJmNTg1NWZhNmVmOWZjMjA2MGUyOGY4MjE5ZGUwOTQxY2Q3MDBmNTM5YTllNGU4M2QyMzQ4M2U4ZjQ5YmY). If the link is not working, find the latest one at [Apache INFRA WIKI](https://cwiki.apache.org/confluence/display/INFRA/Slack+Guest+Invites).\n* QQ Group: 392443393(2000/2000, not available), 901167865(available)\n\n# License\nApache 2.0\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fapache%2Fskywalking-agent-test-tool","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fapache%2Fskywalking-agent-test-tool","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fapache%2Fskywalking-agent-test-tool/lists"}