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
185
186
187
188
189
190
191
|
# Licensed to Elasticsearch B.V. under one or more contributor
# license agreements. See the NOTICE file distributed with
# this work for additional information regarding copyright
# ownership. Elasticsearch B.V. 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.
import json
import logging
from io import StringIO
import elasticapm
import structlog
from elasticapm.handlers.logging import LoggingFilter
from elasticapm.handlers.structlog import structlog_processor
import ecs_logging
def test_elasticapm_structlog_log_correlation_ecs_fields(spec_validator, apm):
stream = StringIO()
logger = structlog.PrintLogger(stream)
logger = structlog.wrap_logger(
logger, processors=[structlog_processor, ecs_logging.StructlogFormatter()]
)
log = logger.new()
apm.begin_transaction("test-transaction")
try:
with elasticapm.capture_span("test-span"):
span_id = elasticapm.get_span_id()
trace_id = elasticapm.get_trace_id()
transaction_id = elasticapm.get_transaction_id()
log.info("test message")
finally:
apm.end_transaction("test-transaction")
ecs = json.loads(spec_validator(stream.getvalue().rstrip()))
ecs.pop("@timestamp")
assert ecs == {
"ecs.version": "1.6.0",
"log.level": "info",
"message": "test message",
"span": {"id": span_id},
"trace": {"id": trace_id},
"transaction": {"id": transaction_id},
"service": {"name": "apm-service", "environment": "dev"},
}
def test_elastic_apm_stdlib_no_filter_log_correlation_ecs_fields(apm):
stream = StringIO()
logger = logging.getLogger("apm-logger")
handler = logging.StreamHandler(stream)
handler.setFormatter(
ecs_logging.StdlibFormatter(
exclude_fields=["@timestamp", "process", "log.origin.file.line"]
)
)
logger.addHandler(handler)
logger.setLevel(logging.DEBUG)
apm.begin_transaction("test-transaction")
try:
with elasticapm.capture_span("test-span"):
span_id = elasticapm.get_span_id()
trace_id = elasticapm.get_trace_id()
transaction_id = elasticapm.get_transaction_id()
logger.info("test message")
finally:
apm.end_transaction("test-transaction")
ecs = json.loads(stream.getvalue().rstrip())
assert ecs == {
"ecs.version": "1.6.0",
"log.level": "info",
"log": {
"logger": "apm-logger",
"origin": {
"file": {"name": "test_apm.py"},
"function": "test_elastic_apm_stdlib_no_filter_log_correlation_ecs_fields",
},
"original": "test message",
},
"message": "test message",
"span": {"id": span_id},
"trace": {"id": trace_id},
"transaction": {"id": transaction_id},
"service": {"name": "apm-service", "environment": "dev"},
}
def test_elastic_apm_stdlib_with_filter_log_correlation_ecs_fields(apm):
stream = StringIO()
logger = logging.getLogger("apm-logger")
handler = logging.StreamHandler(stream)
handler.setFormatter(
ecs_logging.StdlibFormatter(
exclude_fields=["@timestamp", "process", "log.origin.file.line"]
)
)
handler.addFilter(LoggingFilter())
logger.addHandler(handler)
logger.setLevel(logging.DEBUG)
apm.begin_transaction("test-transaction")
try:
with elasticapm.capture_span("test-span"):
span_id = elasticapm.get_span_id()
trace_id = elasticapm.get_trace_id()
transaction_id = elasticapm.get_transaction_id()
logger.info("test message")
finally:
apm.end_transaction("test-transaction")
ecs = json.loads(stream.getvalue().rstrip())
assert ecs == {
"ecs.version": "1.6.0",
"log.level": "info",
"log": {
"logger": "apm-logger",
"origin": {
"file": {"name": "test_apm.py"},
"function": "test_elastic_apm_stdlib_with_filter_log_correlation_ecs_fields",
},
"original": "test message",
},
"message": "test message",
"span": {"id": span_id},
"trace": {"id": trace_id},
"transaction": {"id": transaction_id},
"service": {"name": "apm-service", "environment": "dev"},
}
def test_elastic_apm_stdlib_exclude_fields(apm):
stream = StringIO()
logger = logging.getLogger("apm-logger")
handler = logging.StreamHandler(stream)
handler.setFormatter(
ecs_logging.StdlibFormatter(
exclude_fields=[
"@timestamp",
"process",
"log.origin.file.line",
"span",
"transaction.id",
]
)
)
logger.addHandler(handler)
logger.setLevel(logging.DEBUG)
apm.begin_transaction("test-transaction")
try:
with elasticapm.capture_span("test-span"):
trace_id = elasticapm.get_trace_id()
logger.info("test message")
finally:
apm.end_transaction("test-transaction")
ecs = json.loads(stream.getvalue().rstrip())
assert ecs == {
"ecs.version": "1.6.0",
"log.level": "info",
"log": {
"logger": "apm-logger",
"origin": {
"file": {"name": "test_apm.py"},
"function": "test_elastic_apm_stdlib_exclude_fields",
},
"original": "test message",
},
"message": "test message",
"trace": {"id": trace_id},
"service": {"name": "apm-service", "environment": "dev"},
}
|
