forked from open-telemetry/opentelemetry-java
-
Notifications
You must be signed in to change notification settings - Fork 1
/
SdkLoggerTest.java
184 lines (159 loc) · 7.12 KB
/
SdkLoggerTest.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
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
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
/*
* Copyright The OpenTelemetry Authors
* SPDX-License-Identifier: Apache-2.0
*/
package io.opentelemetry.sdk.logs;
import static io.opentelemetry.api.common.AttributeKey.booleanArrayKey;
import static io.opentelemetry.api.common.AttributeKey.doubleArrayKey;
import static io.opentelemetry.api.common.AttributeKey.longArrayKey;
import static io.opentelemetry.api.common.AttributeKey.stringArrayKey;
import static io.opentelemetry.api.internal.ValidationUtil.API_USAGE_LOGGER_NAME;
import static io.opentelemetry.sdk.testing.assertj.LogAssertions.assertThat;
import static io.opentelemetry.sdk.testing.assertj.OpenTelemetryAssertions.assertThat;
import static org.mockito.ArgumentMatchers.any;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.never;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.when;
import io.github.netmikey.logunit.api.LogCapturer;
import io.opentelemetry.api.common.AttributeKey;
import io.opentelemetry.api.common.Attributes;
import io.opentelemetry.api.common.AttributesBuilder;
import io.opentelemetry.api.internal.StringUtils;
import io.opentelemetry.api.logs.LogRecordBuilder;
import io.opentelemetry.internal.testing.slf4j.SuppressLogger;
import io.opentelemetry.sdk.common.Clock;
import io.opentelemetry.sdk.common.CompletableResultCode;
import io.opentelemetry.sdk.common.InstrumentationScopeInfo;
import io.opentelemetry.sdk.resources.Resource;
import java.util.Arrays;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.atomic.AtomicReference;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.RegisterExtension;
import org.slf4j.event.LoggingEvent;
class SdkLoggerTest {
@RegisterExtension
LogCapturer apiUsageLogs = LogCapturer.create().captureForLogger(API_USAGE_LOGGER_NAME);
@Test
void logRecordBuilder() {
LoggerSharedState state = mock(LoggerSharedState.class);
InstrumentationScopeInfo info = InstrumentationScopeInfo.create("foo");
AtomicReference<ReadWriteLogRecord> seenLog = new AtomicReference<>();
LogRecordProcessor logRecordProcessor = (logRecord, context) -> seenLog.set(logRecord);
Clock clock = mock(Clock.class);
when(clock.now()).thenReturn(5L);
when(state.getResource()).thenReturn(Resource.getDefault());
when(state.getLogRecordProcessor()).thenReturn(logRecordProcessor);
when(state.getClock()).thenReturn(clock);
SdkLogger logger = new SdkLogger(state, info);
LogRecordBuilder logRecordBuilder = logger.logRecordBuilder();
logRecordBuilder.setBody("foo");
// Have to test through the builder
logRecordBuilder.emit();
assertThat(seenLog.get().toLogRecordData()).hasBody("foo").hasEpochNanos(5);
}
@Test
void logRecordBuilder_maxAttributeLength() {
int maxLength = 25;
AtomicReference<ReadWriteLogRecord> seenLog = new AtomicReference<>();
SdkLoggerProvider loggerProvider =
SdkLoggerProvider.builder()
.addLogRecordProcessor((logRecord, context) -> seenLog.set(logRecord))
.setLogLimits(() -> LogLimits.builder().setMaxAttributeValueLength(maxLength).build())
.build();
LogRecordBuilder logRecordBuilder = loggerProvider.get("test").logRecordBuilder();
String strVal = StringUtils.padLeft("", maxLength);
String tooLongStrVal = strVal + strVal;
logRecordBuilder
.setAllAttributes(
Attributes.builder()
.put("string", tooLongStrVal)
.put("boolean", true)
.put("long", 1L)
.put("double", 1.0)
.put(stringArrayKey("stringArray"), Arrays.asList(strVal, tooLongStrVal))
.put(booleanArrayKey("booleanArray"), Arrays.asList(true, false))
.put(longArrayKey("longArray"), Arrays.asList(1L, 2L))
.put(doubleArrayKey("doubleArray"), Arrays.asList(1.0, 2.0))
.build())
.emit();
Attributes attributes = seenLog.get().toLogRecordData().getAttributes();
assertThat(attributes)
.containsEntry("string", strVal)
.containsEntry("boolean", true)
.containsEntry("long", 1L)
.containsEntry("double", 1.0)
.containsEntry("stringArray", strVal, strVal)
.containsEntry("booleanArray", true, false)
.containsEntry("longArray", 1L, 2L)
.containsEntry("doubleArray", 1.0, 2.0);
}
@Test
void logRecordBuilder_maxAttributes() {
int maxNumberOfAttrs = 8;
AtomicReference<ReadWriteLogRecord> seenLog = new AtomicReference<>();
SdkLoggerProvider loggerProvider =
SdkLoggerProvider.builder()
.addLogRecordProcessor((logRecord, context) -> seenLog.set(logRecord))
.setLogLimits(
() -> LogLimits.builder().setMaxNumberOfAttributes(maxNumberOfAttrs).build())
.build();
LogRecordBuilder builder = loggerProvider.get("test").logRecordBuilder();
AttributesBuilder expectedAttributes = Attributes.builder();
for (int i = 0; i < 2 * maxNumberOfAttrs; i++) {
AttributeKey<Long> key = AttributeKey.longKey("key" + i);
builder.setAttribute(key, (long) i);
if (i < maxNumberOfAttrs) {
expectedAttributes.put(key, (long) i);
}
}
builder.emit();
assertThat(seenLog.get().toLogRecordData())
.hasAttributes(expectedAttributes.build())
.hasTotalAttributeCount(maxNumberOfAttrs * 2);
}
@Test
void logRecordBuilder_AfterShutdown() {
LogRecordProcessor logRecordProcessor = mock(LogRecordProcessor.class);
when(logRecordProcessor.shutdown()).thenReturn(CompletableResultCode.ofSuccess());
SdkLoggerProvider loggerProvider =
SdkLoggerProvider.builder().addLogRecordProcessor(logRecordProcessor).build();
loggerProvider.shutdown().join(10, TimeUnit.SECONDS);
loggerProvider.get("test").logRecordBuilder().emit();
verify(logRecordProcessor, never()).onEmit(any(), any());
}
@Test
@SuppressLogger(loggerName = API_USAGE_LOGGER_NAME)
void eventBuilder() {
AtomicReference<ReadWriteLogRecord> seenLog = new AtomicReference<>();
SdkLoggerProvider loggerProvider =
SdkLoggerProvider.builder()
.addLogRecordProcessor((logRecord, context) -> seenLog.set(logRecord))
.build();
// Emit event from logger with name and add event domain
loggerProvider
.loggerBuilder("test")
.setEventDomain("event-domain")
.build()
.eventBuilder("event-name")
.emit();
assertThat(seenLog.get().toLogRecordData())
.hasAttributes(
Attributes.builder()
.put("event.domain", "event-domain")
.put("event.name", "event-name")
.build());
assertThat(apiUsageLogs.getEvents()).isEmpty();
seenLog.set(null);
// Emit event from logger with name and no event domain
loggerProvider.get("test").eventBuilder("event-name");
assertThat(apiUsageLogs.getEvents())
.hasSize(1)
.extracting(LoggingEvent::getMessage)
.allMatch(
log ->
log.equals(
"Cannot emit event from Logger without event domain. Please use LoggerBuilder#setEventDomain(String) when obtaining Logger."));
}
}