Skip to content

Commit 2bb76ea

Browse files
stevejgordonMpdreamzgregkalapos
authored
[MANUAL] post-release: v1.26.0 (#2324)
* Add release notes for 1.25.2 (#2240) * Add CHANGELOG for 1.25.3 (#2250) * Add release notes for 1.26.0 (#2294) * Add release notes for 1.26.0 * Update CHANGELOG.asciidoc Co-authored-by: Gergely Kalapos <[email protected]> --------- Co-authored-by: Gergely Kalapos <[email protected]> * Update to .NET 8 SDK (#2304) * Update to .NET 8 SDK * Fix bootstrap action * Fix setup dotnet * Fix up test data * Update ES tests * Update dependencies * Fix ASP.NET Core tests * Bump version in web.config * Various profiler updates * Update functions apps * Update troubleshooting section of docs (#2302) * Update troubleshooting * Fix doc * Remove special case trace logging * Clarify logging behaviour in troubleshooting doc (#2314) * Add dates to releases for versions released in the last two years --------- Co-authored-by: Martijn Laarman <[email protected]> Co-authored-by: Gergely Kalapos <[email protected]>
1 parent bb7d655 commit 2bb76ea

File tree

3 files changed

+91
-21
lines changed

3 files changed

+91
-21
lines changed

CHANGELOG.asciidoc

Lines changed: 67 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
ifdef::env-github[]
22
NOTE: Release notes are best read in our documentation at
3-
https://www.elastic.co/guide/en/apm/agent/dotnet/current/release-notes.html[elastic.co]
3+
https://www.elastic.co/guide/en/apm/agent/dotnet/current/release-notes.html[elastic.co].
44
endif::[]
55

66
:issue: https://github.com/elastic/apm-agent-dotnet/issues/
@@ -23,8 +23,58 @@ endif::[]
2323
[[release-notes-1.x]]
2424
=== .NET Agent version 1.x
2525
26+
[[release-notes-1.26.0]]
27+
==== 1.26.0 - 2024/02/20
28+
29+
This release introduces more thorough sanitization of request/response cookies to align with the APM spec.
30+
The incoming `Cookie` is now redacted by default. The cookies it contains are extracted and sanitized according
31+
to the `SanitizeFieldNames` configuration. Response headers are now correctly sanitized, including the
32+
`Set-Cookie` header. This is a behaviour change!
33+
34+
===== Features
35+
36+
{pull}2290[#2290] Fully implement the sanitization spec for request/response headers
37+
{pull}2272[#2272] Include process information in metadata stanza when emitting events to apm-server
38+
{pull}2264[#2264] Switch to Licence expression rather than file
39+
40+
===== Bug fixes
41+
42+
{pull}2267[#2267] Cleanup of packages thanks to Framework reference
43+
{pull}2274[#2274] Limit memory usage when capturing SOAP request bodies
44+
{pull}2276[#2276] Address a few synchronization issues in the codebase
45+
{pull}2277[#2277] Truncate unknown keys logging from central config parser
46+
{pull}2278[#2278] Ensure exposed default constants are readonly
47+
{pull}2283[#2283] Fix duplicate key errors on dropped span stats update
48+
{pull}2279[#2279] Remove RegexConverter, not used in serialization from and to apm-server
49+
{pull}2280[#2280] Cleanup some dead code and one instance of null propagation in tooling NOT userfacing code
50+
51+
52+
[[release-notes-1.25.3]]
53+
==== 1.25.3 - 2024/01/08
54+
55+
===== Bug fixes
56+
57+
{pull}2241[#2241] TagObjects not guaranteed to be unique
58+
{pull}2242[#2242] Move logging caching over to ConditionalWeaktable
59+
{pull}2247[#2247] Add additional logging to outgoing http call propagation
60+
{pull}2249[#2249] address multiple structured logging violations
61+
{pull}2245[#2245] Update MongoDB drivers to 2.19.0
62+
63+
[[release-notes-1.25.2]]
64+
==== 1.25.2 - 2023/12/13
65+
66+
This release fixes a bug in `Elastic.Apm.AspNetCore` when using ` UseElasticApm()` not correctly setting status codes.
67+
The bug was not present in the more commonly used `Elastic.Apm.NetCoreAll` since it uses a `DiagnosticListener` approach.
68+
With this release we ensure both packages use the exact same `DiagnosticListener` mechanism to instrument ASP.NET Core.
69+
70+
===== Bug fixes
71+
72+
{pull}2213[#2213] Remove ApmMiddleWare, only use DiagnosticSource listener for ASP.NET Core.
73+
{pull}2239[#2239] Move StartupHooks over to netstandard2.0.
74+
75+
2676
[[release-notes-1.25.1]]
27-
==== 1.25.1
77+
==== 1.25.1 - 2023/11/21
2878
2979
===== Bug fixes
3080
@@ -34,13 +84,13 @@ endif::[]
3484
{pull}2220[#2220] Ensure baggage gets copied with baggage prefix by
3585
3686
[[release-notes-1.25.0]]
37-
==== 1.25.0
87+
==== 1.25.0 - 2023/10/19
3888
3989
===== Features
4090
{pull}2196[#2196] Support OnExecuteRequestStep available in new .NET versions for IIS modules.
4191
4292
[[release-notes-1.24.0]]
43-
==== 1.24.0
93+
==== 1.24.0 - 2023/09/20
4494
4595
===== Features
4696
{pull}2140[#2140] Enable OpenTelemetryBridge by default
@@ -56,7 +106,7 @@ endif::[]
56106
{pull}2182[#2182] Handle SqlExceptions when accessing user claims
57107
58108
[[release-notes-1.23.0]]
59-
==== 1.23.0
109+
==== 1.23.0 - 2023/08/08
60110
61111
===== Features
62112
{pull}2069[#2069] .NET Full Framework now always loads configuration from web or app.config
@@ -72,7 +122,7 @@ endif::[]
72122
{pull}2148[#2148] Move Redis Profiler registration to ConditionalWeakTable
73123
74124
[[release-notes-1.22.0]]
75-
==== 1.22.0
125+
==== 1.22.0 - 2023/04/28
76126
77127
===== Features
78128
- {pull}2050[#2050] Enable listening to `Microsoft.Data.SqlClient.EventSource` on .NET full framework.
@@ -83,7 +133,7 @@ endif::[]
83133
84134
85135
[[release-notes-1.21.0]]
86-
==== 1.21.0
136+
==== 1.21.0 - 2023/04/05
87137
88138
This release includes two breaking changes that have minimal impact.
89139
@@ -101,7 +151,7 @@ Since these are currently not displayed in the APM UI, while technically breakin
101151
- {pull}2041[#2041] Prevent sending activation_method in metadata for 8.7.0
102152
103153
[[release-notes-1.20.0]]
104-
==== 1.20.0
154+
==== 1.20.0 - 2023/02/27
105155
106156
===== Features
107157
- {pull}1981[#1981] Support for Azure Functions through new `Elastic.Apm.Azure.Functions` nuget package!
@@ -122,7 +172,7 @@ Since these are currently not displayed in the APM UI, while technically breakin
122172
123173
124174
[[release-notes-1.19.0]]
125-
==== 1.19.0
175+
==== 1.19.0 - 2022/12/05
126176
127177
===== Features
128178
- {pull}1867[#1867] Improve handling of multiple agent initialization.
@@ -141,7 +191,7 @@ Since these are currently not displayed in the APM UI, while technically breakin
141191
- {pull}1933[#1933] Enable DOTNET_STARTUP_HOOKS for .NET 7 (issue: {issue}1900[#1900]).
142192
143193
[[release-notes-1.18.0]]
144-
==== 1.18.0
194+
==== 1.18.0 - 2022/10/13
145195
146196
===== Features
147197
- Profiler based agent is now GA
@@ -157,7 +207,7 @@ Since these are currently not displayed in the APM UI, while technically breakin
157207
- {pull}1816[#1816] Group MetricSets in BreakdownMetricsProvider (issue: {issue}1678[#1678]).
158208
159209
[[release-notes-1.17.0]]
160-
==== 1.17.0
210+
==== 1.17.0 - 2022/08/24
161211
162212
===== Features
163213
- {pull}1739[#1739] Introduce the `TraceContinuationStrategy` config (issue: {issue}1637[#1637]).
@@ -174,7 +224,7 @@ Since these are currently not displayed in the APM UI, while technically breakin
174224
- {pull}1787[#1787] Fix FillApmServerInfo : Invalid ElasticApm_ApiKey throws Exception (issue: {issue}1735[#1735]).
175225
176226
[[release-notes-1.16.1]]
177-
==== 1.16.1
227+
==== 1.16.1 - 2022/06/15
178228
179229
===== Features
180230
- {pull}1732[#1732] Improved logging around fetching central configuration (issue: {issue}1626[#1626]).
@@ -184,7 +234,7 @@ Since these are currently not displayed in the APM UI, while technically breakin
184234
- Handling RouteData with `null` in legacy ASP.NET Core 2.2 apps (issue: {issue}1729[#1729]).
185235
186236
[[release-notes-1.16.0]]
187-
==== 1.16.0
237+
==== 1.16.0 - 2022/06/02
188238
189239
[float]
190240
===== Features
@@ -195,7 +245,7 @@ Since these are currently not displayed in the APM UI, while technically breakin
195245
- {pull}1723[#1723] Transaction names for incoming HTTP requests returning 404 but matching a valid route, will include the URL path instead of using `unknown route` (issue: {issue}1715[#1715]).
196246
197247
[[release-notes-1.15.0]]
198-
==== 1.15.0
248+
==== 1.15.0 - 2022/05/12
199249
200250
[float]
201251
===== Features
@@ -210,7 +260,7 @@ Since these are currently not displayed in the APM UI, while technically breakin
210260
- {pull}1685[#1685] Handle missing `.Stop` events in `AspNetCoreDiagnosticListener` (issue: {issue}1676[#1676])
211261
212262
[[release-notes-1.14.1]]
213-
==== 1.14.1
263+
==== 1.14.1 - 2022/03/10
214264
215265
[float]
216266
===== Bug fixes
@@ -219,7 +269,7 @@ Since these are currently not displayed in the APM UI, while technically breakin
219269
- {pull}1648[#1648] OpenTelemetry (Activity) bridge - APM Server version check
220270
221271
[[release-notes-1.14.0]]
222-
==== 1.14.0
272+
==== 1.14.0 - 2022/02/09
223273
224274
[float]
225275
===== Features
@@ -236,7 +286,7 @@ Since these are currently not displayed in the APM UI, while technically breakin
236286
- {pull}1586[#1586] Change unknown service.name to align with other agents. In the very rare cases when the agent is not able to autoamtically detect the name of a service, or it's not manually set, it'll use the default service name `unknown-dotnet-service`. In prior versions this was just `unknown`. (issue: {issue}1585[#1585])
237287
238288
[[release-notes-1.13.0]]
239-
==== 1.13.0
289+
==== 1.13.0 - 2022/01/12
240290
241291
[float]
242292
===== Features

docs/docs.csproj

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<Project Sdk="Microsoft.NET.Sdk">
22
<PropertyGroup>
3-
<TargetFramework>net7.0</TargetFramework>
3+
<TargetFramework>net8.0</TargetFramework>
44
<IsPackable>False</IsPackable>
55
</PropertyGroup>
66

docs/troubleshooting.asciidoc

Lines changed: 23 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -39,9 +39,29 @@ The way to collect logs depends on the setup of your application.
3939
==== ASP.NET Core
4040

4141
If you added the agent to your application as per the <<setup-asp-net-core>> document with the `UseAllElasticApm` or `UseElasticApm` method, it will integrate with the
42-
https://docs.microsoft.com/en-us/aspnet/core/fundamentals/logging/?view=aspnetcore-3.1[ASP.NET Core logging infrastructure].
42+
https://docs.microsoft.com/en-us/aspnet/core/fundamentals/logging[ASP.NET Core logging infrastructure].
4343
This means the Agent will pick up the configured logging provider and log as any other component logs.
4444

45+
[IMPORTANT]
46+
--
47+
In this scenario, the `LogLevel` APM agent configuration (e.g. setting the `ELASTIC_APM_LOG_LEVEL` environment variable) DOES NOT control the
48+
verbosity of the agent logs. The agent logs are controlled by the ASP.NET Core logging configuration from `IConfiguration`, typically configured
49+
via `appsettings.json`.
50+
--
51+
52+
For example, the following configuration in `appsettings.json` limits APM agents logs to those with a log level of `Warning` or higher:
53+
54+
[source,xml]
55+
----
56+
"Logging": {
57+
"LogLevel": {
58+
"Default": "Information",
59+
"Elastic.Apm": "Warning" <1>
60+
}
61+
},
62+
----
63+
<1> Control the verbosity of the agent logs by setting the log level for the `Elastic.Apm` category
64+
4565
[float]
4666
[[collect-logs-classic]]
4767
==== ASP.NET Classic
@@ -50,7 +70,7 @@ ASP.NET (classic) does not have a predefined logging system. By default, the age
5070
emit log messages to a
5171
https://docs.microsoft.com/en-us/dotnet/api/system.diagnostics.tracesource[`System.Diagnostics.TraceSource`]
5272
with the source name `"Elastic.Apm"`. The TraceSource adheres to the log levels defined in the
53-
APM agent configuration.
73+
APM agent configuration. Typically, you will configure a preferred log level using an application setting in `web.config`.
5474

5575
[IMPORTANT]
5676
--
@@ -67,7 +87,7 @@ named my_log_file.log:
6787
----
6888
<configuration>
6989
<!-- other sections .... -->
70-
<system.diagnostics>
90+
<system.diagnostics>
7191
<sources>
7292
<source name="Elastic.Apm"> <1>
7393
<listeners>

0 commit comments

Comments
 (0)