skywalking-java/docs/en/setup/backend/backend-receivers.md

Choose receiver

Receiver is a concept in SkyWalking backend. All modules, which are responsible for receiving telemetry or tracing data from other being monitored system, are all being called Receiver. Although today, most of receivers are using gRPC or HTTPRestful to provide service, actually, whether listening mode or pull mode could be receiver. Such as a receiver could base on pull data from remote, like Kakfa MQ.

We have following receivers, and default implementors are provided in our Apache distribution.zzz

1. receiver-trace. gRPC and HTTPRestful services to accept SkyWalking format traces.
2. receiver-register. gRPC and HTTPRestful services to provide service, service instance and endpoint register.
3. service-mesh. gRPC services accept data from inbound mesh probes.
4. receiver-jvm. gRPC services accept JVM metric data.
5. istio-telemetry. Istio telemetry is from Istio official bypass adaptor, this receiver match its gRPC services.
6. envoy-metric. Envoy metrics_service supported by this receiver. OAL script support all GAUGE type metrics.
7. receiver_zipkin. HTTP service accepts Span in Zipkin v1 and v2 formats. Notice, this receiver only works as expected in backend single node mode. Cluster mode is not supported. Welcome anyone to improve this.

The sample settings of these receivers should be already in default application.yml, and also list here

receiver-register:
  default:
receiver-trace:
  default:
    bufferPath: ../trace-buffer/  # Path to trace buffer files, suggest to use absolute path
    bufferOffsetMaxFileSize: 100 # Unit is MB
    bufferDataMaxFileSize: 500 # Unit is MB
    bufferFileCleanWhenRestart: false
    sampleRate: ${SW_TRACE_SAMPLE_RATE:1000} # The sample rate precision is 1/10000. 10000 means 100% sample in default.
receiver-jvm:
  default:
service-mesh:
  default:
    bufferPath: ../mesh-buffer/  # Path to trace buffer files, suggest to use absolute path
    bufferOffsetMaxFileSize: 100 # Unit is MB
    bufferDataMaxFileSize: 500 # Unit is MB
    bufferFileCleanWhenRestart: false
istio-telemetry:
  default:
envoy-metric:
  default:
receiver_zipkin:
  default:
    host: 0.0.0.0
    port: 9411
    contextPath: /

gRPC/HTTP server for receiver

In default, all gRPC/HTTP services should be served at core/gRPC and core/rest. But the receiver-sharing-server module provide a way to make all receivers serving at different ip:port, if you set them explicitly.

receiver-sharing-server:
  default:
    restHost: ${SW_SHARING_SERVER_REST_HOST:0.0.0.0}
    restPort: ${SW_SHARING_SERVER_REST_PORT:12800}
    restContextPath: ${SW_SHARING_SERVER_REST_CONTEXT_PATH:/}
    gRPCHost: ${SW_SHARING_SERVER_GRPC_HOST:0.0.0.0}
    gRPCPort: ${SW_SHARING_SERVER_GRPC_PORT:11800}

Notice, if you add these settings, make sure they are not as same as core module, because gRPC/HTTP servers of core are still used for UI and OAP internal communications.