Debian Codegraph @

opentelemetry/proto/collector/profiles/v1development/profiles_service.proto

raw
1 // Copyright 2023, OpenTelemetry Authors
2 //
3 // Licensed under the Apache License, Version 2.0 (the "License");
4 // you may not use this file except in compliance with the License.
5 // You may obtain a copy of the License at
6 //
7 // http://www.apache.org/licenses/LICENSE-2.0
8 //
9 // Unless required by applicable law or agreed to in writing, software
10 // distributed under the License is distributed on an "AS IS" BASIS,
11 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 // See the License for the specific language governing permissions and
13 // limitations under the License.
14
15 syntax = "proto3";
16
17 package opentelemetry.proto.collector.profiles.v1development;
18
19 import "opentelemetry/proto/profiles/v1development/profiles.proto";
20
21 option csharp_namespace = "OpenTelemetry.Proto.Collector.Profiles.V1Development";
22 option java_multiple_files = true;
23 option java_package = "io.opentelemetry.proto.collector.profiles.v1development";
24 option java_outer_classname = "ProfilesServiceProto";
25 option go_package = "go.opentelemetry.io/proto/otlp/collector/profiles/v1development";
26
27 // Service that can be used to push profiles between one Application instrumented with
28 // OpenTelemetry and a collector, or between a collector and a central collector.
29 service ProfilesService {
30 rpc Export(ExportProfilesServiceRequest) returns (ExportProfilesServiceResponse) {}
31 }
32
33 message ExportProfilesServiceRequest {
34 // An array of ResourceProfiles.
35 // For data coming from a single resource this array will typically contain one
36 // element. Intermediary nodes (such as OpenTelemetry Collector) that receive
37 // data from multiple origins typically batch the data before forwarding further and
38 // in that case this array will contain multiple elements.
39 repeated opentelemetry.proto.profiles.v1development.ResourceProfiles resource_profiles = 1;
40
41 // The reference table containing all data shared by profiles across the message being sent.
42 opentelemetry.proto.profiles.v1development.ProfilesDictionary dictionary = 2;
43 }
44
45 message ExportProfilesServiceResponse {
46 // The details of a partially successful export request.
47 //
48 // If the request is only partially accepted
49 // (i.e. when the server accepts only parts of the data and rejects the rest)
50 // the server MUST initialize the `partial_success` field and MUST
51 // set the `rejected_<signal>` with the number of items it rejected.
52 //
53 // Servers MAY also make use of the `partial_success` field to convey
54 // warnings/suggestions to senders even when the request was fully accepted.
55 // In such cases, the `rejected_<signal>` MUST have a value of `0` and
56 // the `error_message` MUST be non-empty.
57 //
58 // A `partial_success` message with an empty value (rejected_<signal> = 0 and
59 // `error_message` = "") is equivalent to it not being set/present. Senders
60 // SHOULD interpret it the same way as in the full success case.
61 ExportProfilesPartialSuccess partial_success = 1;
62 }
63
64 message ExportProfilesPartialSuccess {
65 // The number of rejected profiles.
66 //
67 // A `rejected_<signal>` field holding a `0` value indicates that the
68 // request was fully accepted.
69 int64 rejected_profiles = 1;
70
71 // A developer-facing human-readable message in English. It should be used
72 // either to explain why the server rejected parts of the data during a partial
73 // success or to convey warnings/suggestions during a full success. The message
74 // should offer guidance on how users can address such issues.
75 //
76 // error_message is an optional field. An error_message with an empty value
77 // is equivalent to it not being set.
78 string error_message = 2;
79 }