Skip to content

Latest commit

 

History

History
66 lines (48 loc) · 3.86 KB

README.md

File metadata and controls

66 lines (48 loc) · 3.86 KB
Raw

Probe Protocol

It includes descriptions and definitions on how agents send collected metrics, logs, traces and events, as well as the format of each entity.

Probe Protocols

They also related to the probe group. For more information, see Concepts and Designs. These groups are language-based native agent protocol, service mesh protocol and 3rd-party instrument protocol.

Tracing

There are two types of protocols that help language agents work in distributed tracing.

  • Cross Process Propagation Headers Protocol and Cross Process Correlation Headers Protocol come in in-wire data format. Agent/SDK usually uses HTTP/MQ/HTTP2 headers to carry the data with the RPC request. The remote agent will receive this in the request handler, and bind the context with this specific request.

Cross Process Propagation Headers Protocol v3 has been the new protocol for in-wire context propagation since the version 8.0.0 release.

Cross Process Correlation Headers Protocol v1 is a new in-wire context propagation protocol which is additional and optional. Please read SkyWalking language agents documentation to see whether it is supported.

  • Trace Data Protocol is an out-of-wire data format. Agent/SDK uses this to send traces to SkyWalking OAP server.

SkyWalking Trace Data Protocol v3 defines the communication method and format between the agent and backend.

Logging

  • Log Data Protocol is an out-of-wire data format. Agent/SDK and collector use this to send logs into SkyWalking OAP server. SkyWalking Log Data Protocol defines the communication method and format between the agent and backend.

Metrics

SkyWalking has native metrics format, and support widely used metric formats such as Prometheus, OpenCensus, and Zabbix.

The native metrics format definition could be found here. Typically, agent meter plugin(e.g. Java Meter Plugin) and Satellite Prometheus fetcher would transfer metrics into native format and forward to SkyWalking OAP server.

About receiving 3rd party formats metrics, read Meter receiver and OpenTelemetry receiver docs for more details.

Browser probe protocol

The browser probe, such as skywalking-client-js, could use this protocol to send data to the backend. This service is provided by gRPC.

SkyWalking Browser Protocol defines the communication method and format between skywalking-client-js and backend.

Events Report Protocol

The protocol is used to report events to the backend. The doc introduces the definition of an event, and the protocol repository defines gRPC services and message formats of events.

Report JSON format events via HTTP API, the endpoint is http://<oap-address>:12800/v3/events. JSON event record example:

[
    {
        "uuid": "f498b3c0-8bca-438d-a5b0-3701826ae21c",
        "source": {
            "service": "SERVICE-A",
            "instance": "INSTANCE-1"
        },
        "name": "Reboot",
        "type": "Normal",
        "message": "App reboot.",
        "parameters": {},
        "startTime": 1628044330000,
        "endTime": 1628044331000
    }
]