-
Notifications
You must be signed in to change notification settings - Fork 105
/
Logging.proto
118 lines (104 loc) · 4.81 KB
/
Logging.proto
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
*/
syntax = "proto3";
package skywalking.v3;
option java_multiple_files = true;
option java_package = "org.apache.skywalking.apm.network.logging.v3";
option csharp_namespace = "SkyWalking.NetworkProtocol.V3";
option go_package = "skywalking.apache.org/repo/goapi/collect/logging/v3";
import "common/Common.proto";
import "common/Command.proto";
// Report collected logs into the OAP backend
service LogReportService {
// Recommend to report log data in a stream mode.
// The service/instance/endpoint of the log could share the previous value if they are not set.
// Reporting the logs of same service in the batch mode could reduce the network cost.
rpc collect (stream LogData) returns (Commands) {
}
}
// Log data is collected through file scratcher of agent.
// Natively, Satellite provides various ways to collect logs.
message LogData {
// [Optional] The timestamp of the log, in millisecond.
// If not set, OAP server would use the received timestamp as log's timestamp, or relies on the OAP server analyzer.
int64 timestamp = 1;
// [Required] **Service**. Represents a set/group of workloads which provide the same behaviours for incoming requests.
//
// The logic name represents the service. This would show as a separate node in the topology.
// The metrics analyzed from the spans, would be aggregated for this entity as the service level.
//
// If this is not the first element of the streaming, use the previous not-null name as the service name.
string service = 2;
// [Optional] **Service Instance**. Each individual workload in the Service group is known as an instance. Like `pods` in Kubernetes, it
// doesn't need to be a single OS process, however, if you are using instrument agents, an instance is actually a real OS process.
//
// The logic name represents the service instance. This would show as a separate node in the instance relationship.
// The metrics analyzed from the spans, would be aggregated for this entity as the service instance level.
string serviceInstance = 3;
// [Optional] **Endpoint**. A path in a service for incoming requests, such as an HTTP URI path or a gRPC service class + method signature.
//
// The logic name represents the endpoint, which logs belong.
string endpoint = 4;
// [Required] The content of the log.
LogDataBody body = 5;
// [Optional] Logs with trace context
TraceContext traceContext = 6;
// [Optional] The available tags. OAP server could provide search/analysis capabilities based on these.
LogTags tags = 7;
// [Optional] Since 9.0.0
// The layer of the service and servce instance. If absent, the OAP would set `layer`=`ID: 2, NAME: general`
string layer = 8;
}
// The content of the log data
message LogDataBody {
// A type to match analyzer(s) at the OAP server.
// The data could be analyzed at the client side, but could be partial
string type = 1;
// Content with extendable format.
oneof content {
TextLog text = 2;
JSONLog json = 3;
YAMLLog yaml = 4;
}
}
// Literal text log, typically requires regex or split mechanism to filter meaningful info.
message TextLog {
string text = 1;
}
// JSON formatted log. The json field represents the string that could be formatted as a JSON object.
message JSONLog {
string json = 1;
}
// YAML formatted log. The yaml field represents the string that could be formatted as a YAML map.
message YAMLLog {
string yaml = 1;
}
// Logs with trace context, represent agent system has injects context(IDs) into log text.
message TraceContext {
// [Optional] A string id represents the whole trace.
string traceId = 1;
// [Optional] A unique id represents this segment. Other segments could use this id to reference as a child segment.
string traceSegmentId = 2;
// [Optional] The number id of the span. Should be unique in the whole segment.
// Starting at 0.
int32 spanId = 3;
}
message LogTags {
// String key, String value pair.
repeated KeyStringValuePair data = 1;
}