Add Custom to Context and expose it via public API #585
Conversation
|
is build failed? @gregkalapos |
We had some known CI issues which we already work on. The build fail is probably not related to this PR. |
| @@ -1,45 +1,50 @@ | |||
| using System; | |||
There was a problem hiding this comment.
Sorry about the lots of changes here - this is again our line ending issue. The only real change here is that I added public Dictionary<string, string> Custom => _custom.Value; and public bool ShouldSerializeCustom() => _custom.IsValueCreated && Custom.Count > 0;
docs/public-api.asciidoc
Outdated
| [[api-transaction-Custom]] | ||
| ==== `Dictionary<string,string> Custom` | ||
|
|
||
| Custom context is used to add non-indexed, custom contextual information to transactions. Non-indexed means the data is not searchable or aggregatable in Elasticsearch, and you cannot build dashboards on top of the data. However, non-indexed information is useful for other reasons, like providing contextual information to help you quickly debug performance issues or errors. |
There was a problem hiding this comment.
Can we move each sentence to its own line?
There was a problem hiding this comment.
Sure, I did it.
Co-Authored-By: Brandon Morelli <[email protected]>
…pos/apm-agent-dotnet into ExposeTransactionCustom
docs/public-api.asciidoc
Outdated
| ---- | ||
| Agent.Tracer.CaptureTransaction(transactionName, transactionType, (transaction) => | ||
| { | ||
| transaction.Custom.Add("foo", "bar"); |
There was a problem hiding this comment.
It might be more consistent to use indexer here just as in Labels example and also it might be worth using value that would not be possible to store as label (i.e., very long string).
There was a problem hiding this comment.
Makes sense, changed it to indexer
| /// </summary> | ||
| [JsonProperty("tags")] | ||
| [JsonConverter(typeof(LabelsJsonConverter))] | ||
| public Dictionary<string, string> Custom => _custom.Value; |
There was a problem hiding this comment.
We need JsonConverter here as well to ensure the keys are valid.
There was a problem hiding this comment.
Added a converter for this - also covered by tests now.
Addressing #582.
Adding and exposing
Customwhich is not yet available in .NET.Also added docs.