forked from grpc/grpc-java
-
Notifications
You must be signed in to change notification settings - Fork 0
/
ObservabilityConfig.java
80 lines (65 loc) · 2.42 KB
/
ObservabilityConfig.java
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
/*
* Copyright 2022 The gRPC Authors
*
* Licensed 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.
*/
package io.grpc.gcp.observability;
import io.grpc.Internal;
import io.grpc.observabilitylog.v1.GrpcLogRecord.EventType;
import io.opencensus.trace.Sampler;
import java.util.List;
import java.util.Map;
@Internal
public interface ObservabilityConfig {
/** Is Cloud Logging enabled. */
boolean isEnableCloudLogging();
/** Is Cloud Monitoring enabled. */
boolean isEnableCloudMonitoring();
/** Is Cloud Tracing enabled. */
boolean isEnableCloudTracing();
/** Get destination project ID - where logs will go. */
String getDestinationProjectId();
/** Get message count threshold to flush - flush once message count is reached. */
Long getFlushMessageCount();
/** Get filters set for logging. */
List<LogFilter> getLogFilters();
/** Get event types to log. */
List<EventType> getEventTypes();
/** Get sampler for TraceConfig - when Cloud Tracing is enabled. */
Sampler getSampler();
/** Map of all custom tags used for logging, metrics and traces. */
Map<String, String> getCustomTags();
/**
* POJO for representing a filter used in configuration.
*/
class LogFilter {
/** Pattern indicating which service/method to log. */
public final String pattern;
/** Number of bytes of each header to log. */
public final Integer headerBytes;
/** Number of bytes of each header to log. */
public final Integer messageBytes;
/**
* Object used to represent filter used in configuration.
*
* @param pattern Pattern indicating which service/method to log
* @param headerBytes Number of bytes of each header to log
* @param messageBytes Number of bytes of each header to log
*/
public LogFilter(String pattern, Integer headerBytes, Integer messageBytes) {
this.pattern = pattern;
this.headerBytes = headerBytes;
this.messageBytes = messageBytes;
}
}
}