Skip to content

Commit

Permalink
Update docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
weixiang committed Sep 14, 2024
1 parent 2f249e2 commit 3a18ae7
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 3 deletions.
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
# Java Agent self-observability
# Agent self-observability
The Java Agent self-observability feature is built-in and used to measure the tracing performance and error statistics of plugins.

It reports meters to SkyWalking oap through native meter protocol, OAP receives and analyzes meters,
which are ultimately presented on the [Java Agent self-observability dashboard](https://skywalking.apache.org/docs/main/next/en/setup/backend/dashboards-so11y-java-agent/).

***Note: Java Agent self-observability dashboard is available since OAP 10.1.0***

# Details of agent so11y meters
- `created_tracing_context_counter` - Counter. The number of created tracing contexts. This includes a label=created_by(value=sampler,propagated). `created_by=propagated` means the agent created the context due to downstream service added sw8 header to trigger force sampling. `created_by=sampler` means the agent created this context by local sampler no matter which policy it uses.
- `finished_tracing_context_counter` - Counter. The number of created contexts. The gap between `finished_tracing_context_counter` and `created_tracing_context_counter` should be relatively stable, otherwise, the memory cost would be increased.
Expand Down
2 changes: 1 addition & 1 deletion docs/en/setup/service-agent/java-agent/Plugin-test.md
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ File Name | Descriptions
| startScript | Path of the start up script. Required in `type: jvm` only.
| runningMode | Running mode with the optional plugin, options, `default`(default), `with_optional`, or `with_bootstrap`.
| withPlugins | Plugin selector rule, e.g.:`apm-spring-annotation-plugin-*.jar`. Required for `runningMode=with_optional` or `runningMode=with_bootstrap`.
| environment | Same as `docker-compose#environment`.
| environment | Same as `docker-compose#environment` and also used as `docker run` environment variables.
| depends_on | Same as `docker-compose#depends_on`.
| dependencies | Same as `docker-compose#services`, `image`, `links`, `hostname`, `command`, `environment` and `depends_on` are supported.

Expand Down
4 changes: 3 additions & 1 deletion docs/menu.yml
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,9 @@ catalog:
- name: "Advanced reporters"
path: "/en/setup/service-agent/java-agent/advanced-reporters"
- name: "Agent Self Observability"
path: "/en/setup/service-agent/java-agent/Java-Agent-self-observability"
path: "/en/setup/service-agent/java-agent/Agent-self-observability"
- name: "Plugin Test Guide"
path: "/en/setup/service-agent/java-agent/Plugin-test/"
- name: "Plugin Development Guide"
path: "/en/setup/service-agent/java-agent/java-plugin-development-guide/"
- name: "Java Agent Performance Test"
Expand Down

0 comments on commit 3a18ae7

Please sign in to comment.