Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/en/changes/changes.md
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,7 @@
* Update Grafana dashboards for OAP observability.
* BanyanDB: fix query `getInstance` by instance ID.
* Support the go agent(0.7.0 release) bundled pprof profiling feature.
* Service and TCPService source support analyze TLS mode.


#### UI
Expand Down
30 changes: 16 additions & 14 deletions docs/en/concepts-and-designs/scope-definitions.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,20 +6,21 @@ Using the Aggregation Function, the requests will be grouped by time and **Group

This calculates the metrics data from each request of the service.

| Name | Remarks | Group Key | Type |
|---------------------------|---------------------------------------------------------------------------------------------------------------------------------|-----------|------------------------|
| name | The name of the service. | | string |
| layer | Layer represents an abstract framework in the computer science, such as operation system(OS_LINUX layer), Kubernetes(k8s layer) | | enum |
| serviceInstanceName | The name of the service instance ID. | | string |
| endpointName | The name of the endpoint, such as a full path of HTTP URI. | | string |
| latency | The time taken by each request. | | int |
| status | Indicates the success or failure of the request. | | bool(true for success) |
| httpResponseStatusCode | The response code of the HTTP response, and if this request is the HTTP call. E.g. 200, 404, 302 | | int |
| rpcStatusCode | The string value of the rpc response code. | | string |
| type | The type of each request. Such as: Database, HTTP, RPC, gRPC. | | enum |
| tags | The labels of each request. Each value is made up by `TagKey:TagValue` in the segment. | | `List<String>` |
| tag | The key-value pair of span tags in the segment. | | `Map<String, String>` |
| sideCar.internalErrorCode | The sidecar/gateway proxy internal error code. The value is based on the implementation. | | string |
| Name | Remarks | Group Key | Type |
|----------------------------|---------------------------------------------------------------------------------------------------------------------------------|-----------|------------------------|
| name | The name of the service. | | string |
| layer | Layer represents an abstract framework in the computer science, such as operation system(OS_LINUX layer), Kubernetes(k8s layer) | | enum |
| serviceInstanceName | The name of the service instance ID. | | string |
| endpointName | The name of the endpoint, such as a full path of HTTP URI. | | string |
| latency | The time taken by each request. | | int |
| status | Indicates the success or failure of the request. | | bool(true for success) |
| httpResponseStatusCode | The response code of the HTTP response, and if this request is the HTTP call. E.g. 200, 404, 302 | | int |
| rpcStatusCode | The string value of the rpc response code. | | string |
| type | The type of each request. Such as: Database, HTTP, RPC, gRPC. | | enum |
| tags | The labels of each request. Each value is made up by `TagKey:TagValue` in the segment. | | `List<String>` |
| tag | The key-value pair of span tags in the segment. | | `Map<String, String>` |
| sideCar.internalErrorCode | The sidecar/gateway proxy internal error code. The value is based on the implementation. | | string |
| tlsMode | The TLS mode of the service | | string |

### SCOPE `TCPService`

Expand All @@ -35,6 +36,7 @@ This calculates the metrics data from each request of the TCP service.
| sideCar.internalErrorCode | The sidecar/gateway proxy internal error code. The value is based on the implementation. | | string |
| receivedBytes | The received bytes of the TCP traffic. | | long |
| sentBytes | The sent bytes of the TCP traffic. | | long |
| tlsMode | The TLS mode of the service | | string |

### SCOPE `ServiceInstance`

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,9 @@ public String getEntityId() {
private SideCar sideCar = new SideCar();
@Getter
@Setter
private String tlsMode;
@Getter
@Setter
@ScopeDefaultColumn.DefinedByField(columnName = "attr0", isAttribute = true)
private String attr0;
@Getter
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -64,14 +64,15 @@ public String getEntityId() {
@Getter
@Setter
private SideCar sideCar = new SideCar();

@Getter
@Setter
private long receivedBytes;

@Getter
@Setter
private long sentBytes;
@Getter
@Setter
private String tlsMode;

public String getTag(String key) {
return originalTags.get(key);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -226,6 +226,7 @@ private static void toService(HTTPServiceMeshMetric.Builder metrics, long minute
service.getSideCar().setInternalErrorCode(metrics.getInternalErrorCode());
service.getSideCar().setInternalRequestLatencyNanos(metrics.getInternalRequestLatencyNanos());
service.getSideCar().setInternalResponseLatencyNanos(metrics.getInternalResponseLatencyNanos());
service.setTlsMode(metrics.getTlsMode());

SOURCE_RECEIVER.receive(service);
}
Expand All @@ -241,6 +242,7 @@ private static void toTCPService(TCPServiceMeshMetric.Builder metrics, long minu
service.getSideCar().setInternalResponseLatencyNanos(metrics.getInternalResponseLatencyNanos());
service.setReceivedBytes(metrics.getReceivedBytes());
service.setSentBytes(metrics.getSentBytes());
service.setTlsMode(metrics.getTlsMode());

SOURCE_RECEIVER.receive(service);
}
Expand Down
Loading