System.Diagnostics.ActivitySource support for observability #83
+323
−133
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,80 +1,78 @@ | ||
| STORAGE: NONE | ||
| RESTRICTION: || (== net9.0) (== netstandard2.0) (== netstandard2.1) | ||
| NUGET | ||
| remote: https://api.nuget.org/v3/index.json | ||
| AWSSDK.Core (3.7.400.70) | ||
| Microsoft.Bcl.AsyncInterfaces (>= 1.1) - restriction: || (&& (== net9.0) (< netcoreapp3.1)) (== netstandard2.0) (== netstandard2.1) | ||
| AWSSDK.DynamoDBv2 (3.7.404.11) | ||
| AWSSDK.Core (>= 3.7.400.70 < 4.0) | ||
| DotNet.ReproducibleBuilds (1.2.25) - copy_local: true | ||
| FSharp.Core (4.7.2) | ||
| Microsoft.Bcl.AsyncInterfaces (9.0) - restriction: || (&& (== net9.0) (>= net462)) (&& (== net9.0) (< net8.0)) (== netstandard2.0) (== netstandard2.1) | ||
| System.Threading.Tasks.Extensions (>= 4.5.4) - restriction: || (&& (== net9.0) (>= net462)) (&& (== net9.0) (< netstandard2.1)) (== netstandard2.0) (&& (== netstandard2.1) (>= net462)) | ||
| System.Buffers (4.6) - restriction: || (&& (== net9.0) (>= net462)) (&& (== net9.0) (< netcoreapp2.1)) (== netstandard2.0) (== netstandard2.1) | ||
| System.Diagnostics.DiagnosticSource (9.0) | ||
| System.Memory (>= 4.5.5) - restriction: || (&& (== net9.0) (>= net462)) (&& (== net9.0) (< net8.0)) (== netstandard2.0) (== netstandard2.1) | ||
| System.Runtime.CompilerServices.Unsafe (>= 6.0) - restriction: || (&& (== net9.0) (>= net462)) (&& (== net9.0) (< net8.0)) (== netstandard2.0) (== netstandard2.1) | ||
| System.IO.Pipelines (9.0) - restriction: || (&& (== net9.0) (>= net462)) (&& (== net9.0) (< net8.0)) (== netstandard2.0) (== netstandard2.1) | ||
| System.Buffers (>= 4.5.1) - restriction: || (&& (== net9.0) (>= net462)) (&& (== net9.0) (< net8.0)) (== netstandard2.0) (== netstandard2.1) | ||
| System.Memory (>= 4.5.5) - restriction: || (&& (== net9.0) (>= net462)) (&& (== net9.0) (< net8.0)) (== netstandard2.0) (== netstandard2.1) | ||
| System.Threading.Tasks.Extensions (>= 4.5.4) - restriction: || (&& (== net9.0) (>= net462)) (&& (== net9.0) (< net8.0)) (== netstandard2.0) (== netstandard2.1) | ||
| System.Memory (4.6) - restriction: || (&& (== net9.0) (>= net462)) (&& (== net9.0) (< net8.0)) (== netstandard2.0) (== netstandard2.1) | ||
| System.Buffers (>= 4.6) - restriction: || (&& (== net9.0) (>= net462)) (&& (== net9.0) (< netcoreapp2.1)) (== netstandard2.0) (== netstandard2.1) | ||
| System.Numerics.Vectors (>= 4.6) - restriction: || (&& (== net9.0) (>= net462)) (&& (== net9.0) (< netcoreapp2.1)) (== netstandard2.0) (== netstandard2.1) | ||
| System.Runtime.CompilerServices.Unsafe (>= 6.1) - restriction: || (&& (== net9.0) (>= net462)) (&& (== net9.0) (< netcoreapp2.1)) (== netstandard2.0) (== netstandard2.1) | ||
| System.Numerics.Vectors (4.6) - restriction: || (&& (== net9.0) (>= net462)) (&& (== net9.0) (< netcoreapp2.1)) (== netstandard2.0) (== netstandard2.1) | ||
| System.Runtime.CompilerServices.Unsafe (6.1) - restriction: || (&& (== net9.0) (>= net462)) (&& (== net9.0) (< net8.0)) (&& (== net9.0) (< netcoreapp2.1)) (== netstandard2.0) (== netstandard2.1) | ||
| System.Text.Encodings.Web (9.0) - restriction: || (&& (== net9.0) (>= net462)) (&& (== net9.0) (< net8.0)) (== netstandard2.0) (== netstandard2.1) | ||
| System.Buffers (>= 4.5.1) - restriction: || (&& (== net9.0) (>= net462)) (&& (== net9.0) (< net8.0)) (== netstandard2.0) (== netstandard2.1) | ||
| System.Memory (>= 4.5.5) - restriction: || (&& (== net9.0) (>= net462)) (&& (== net9.0) (< net8.0)) (== netstandard2.0) (== netstandard2.1) | ||
| System.Runtime.CompilerServices.Unsafe (>= 6.0) - restriction: || (&& (== net9.0) (>= net462)) (&& (== net9.0) (< net8.0)) (== netstandard2.0) (== netstandard2.1) | ||
| System.Text.Json (9.0) | ||
| Microsoft.Bcl.AsyncInterfaces (>= 9.0) - restriction: || (&& (== net9.0) (>= net462)) (&& (== net9.0) (< net8.0)) (== netstandard2.0) (== netstandard2.1) | ||
| System.Buffers (>= 4.5.1) - restriction: || (&& (== net9.0) (>= net462)) (&& (== net9.0) (< net8.0)) (== netstandard2.0) (== netstandard2.1) | ||
| System.IO.Pipelines (>= 9.0) - restriction: || (&& (== net9.0) (>= net462)) (&& (== net9.0) (< net8.0)) (== netstandard2.0) (== netstandard2.1) | ||
| System.Memory (>= 4.5.5) - restriction: || (&& (== net9.0) (>= net462)) (&& (== net9.0) (< net8.0)) (== netstandard2.0) (== netstandard2.1) | ||
| System.Runtime.CompilerServices.Unsafe (>= 6.0) - restriction: || (&& (== net9.0) (>= net462)) (&& (== net9.0) (< net8.0)) (== netstandard2.0) (== netstandard2.1) | ||
| System.Text.Encodings.Web (>= 9.0) - restriction: || (&& (== net9.0) (>= net462)) (&& (== net9.0) (< net8.0)) (== netstandard2.0) (== netstandard2.1) | ||
| System.Threading.Tasks.Extensions (>= 4.5.4) - restriction: || (&& (== net9.0) (>= net462)) (&& (== net9.0) (< net8.0)) (== netstandard2.0) (== netstandard2.1) | ||
| System.Threading.Tasks.Extensions (4.6) - restriction: || (&& (== net9.0) (>= net462)) (&& (== net9.0) (< net8.0)) (&& (== net9.0) (< netstandard2.1)) (== netstandard2.0) (== netstandard2.1) | ||
| System.Runtime.CompilerServices.Unsafe (>= 6.1) - restriction: || (&& (== net9.0) (>= net462)) (&& (== net9.0) (< netcoreapp2.1)) (== netstandard2.0) (== netstandard2.1) | ||
| Unquote (6.1) | ||
| FSharp.Core (>= 4.7.2) | ||
| GITHUB | ||
| remote: eiriktsarpalis/TypeShape | ||
| src/TypeShape/TypeShape.fs (6e7fe07c799de723de7e4b32d64a4fd6c1697c7f) | ||
| GROUP Test | ||
| RESTRICTION: == net9.0 | ||
| NUGET | ||
| remote: https://api.nuget.org/v3/index.json | ||
| FsCheck (2.16.6) | ||
| FSharp.Core (>= 4.2.3) | ||
| FSharp.Core (9.0.100) | ||
| Microsoft.CodeCoverage (17.12) | ||
| Microsoft.NET.Test.Sdk (17.12) | ||
| Microsoft.CodeCoverage (>= 17.12) | ||
| Microsoft.TestPlatform.TestHost (>= 17.12) | ||
| Microsoft.TestPlatform.ObjectModel (17.12) | ||
| System.Reflection.Metadata (>= 1.6) | ||
| Microsoft.TestPlatform.TestHost (17.12) | ||
| Microsoft.TestPlatform.ObjectModel (>= 17.12) | ||
| Newtonsoft.Json (>= 13.0.1) | ||
| Newtonsoft.Json (13.0.3) | ||
| System.Reflection.Metadata (9.0) | ||
| xunit (2.9.2) | ||
| xunit.analyzers (>= 1.16) | ||
| xunit.assert (>= 2.9.2) | ||
| xunit.core (2.9.2) | ||
| xunit.abstractions (2.0.3) | ||
| xunit.analyzers (1.18) | ||
| xunit.assert (2.9.2) | ||
| xunit.core (2.9.2) | ||
| xunit.extensibility.core (2.9.2) | ||
| xunit.extensibility.execution (2.9.2) | ||
| xunit.extensibility.core (2.9.2) | ||
| xunit.abstractions (>= 2.0.3) | ||
| xunit.extensibility.execution (2.9.2) | ||
| xunit.extensibility.core (2.9.2) | ||
| xunit.runner.visualstudio (3.0) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,70 @@ | ||
| namespace FSharp.AWS.DynamoDB | ||
|
|
||
| module Diagnostics = | ||
| open System.Diagnostics | ||
| open Amazon.DynamoDBv2.Model | ||
| open System.Text.Json | ||
|
|
||
| let private activitySource = new ActivitySource("FSharp.AWS.DynamoDB") | ||
|
|
||
| let hasListeners () : bool = activitySource.HasListeners() | ||
|
|
||
| let addActivityTags (tags: (string * obj) list) (activity: Activity) = | ||
| if notNull activity then | ||
| tags |> List.iter (fun (k, v) -> activity.AddTag(k, v) |> ignore) | ||
|
|
||
| let startTableActivity (tableName: string) (operation: string) (tags: (string * obj) list) : Activity = | ||
| let activity = activitySource.StartActivity(sprintf "%s %s" operation tableName, ActivityKind.Client) | ||
| activity | ||
| |> addActivityTags ( | ||
| tags | ||
| |> List.append | ||
| [ ("db.system", "dynamodb") | ||
| ("aws.dynamodb.table_names", [| tableName |]) | ||
| ("rpc.system", "aws-api") | ||
| ("rpc.service", "DynamoDB") | ||
| ("rpc.method", operation) ] | ||
| ) | ||
| activity | ||
|
|
||
| let startMultipleTableActivity (tableNames: string seq) (operation: string) (tags: (string * obj) list) : Activity = | ||
| let activity = activitySource.StartActivity(operation, ActivityKind.Client) | ||
| activity | ||
| |> addActivityTags ( | ||
| tags | ||
| |> List.append | ||
| [ ("db.system", "dynamodb") | ||
| ("aws.dynamodb.table_names", tableNames |> Seq.toArray :> obj) | ||
| ("rpc.system", "aws-api") | ||
| ("rpc.service", "DynamoDB") | ||
| ("rpc.method", operation) ] | ||
| ) | ||
| activity | ||
|
|
||
| let addActivityCapacity (capacity: ConsumedCapacity seq) (activity: Activity) = | ||
| if notNull activity then | ||
| let value = capacity |> Seq.choose (function | null -> None | c -> Some (JsonSerializer.Serialize c)) |> Seq.toArray | ||
|
There was a problem hiding this comment. this fels wrong; surely there's a generic dictionary shape or something? or maybe it can be flattened into an entry per table, or... anything?! There was a problem hiding this comment. I don’t like it either, but the semantic conventions specifically define it like this. It would make more sense to me to use dynamic attribute keys - I’m just as happy to leave it out, and maybe add metrics instead. There was a problem hiding this comment. sgtm - I think iterative tweaks make sense for this sort of work anyway - no subsittute for using it IRL to make you realise what works and doesnt |
||
| activity.AddTag("aws.dynamodb.consumed_capacity", value :> obj) |> ignore | ||
|
|
||
| let addActivityException (ex: exn) (activity: Activity) = | ||
| if notNull activity then | ||
| activity.AddException ex |> ignore | ||
|
|
||
| let stopActivity (activity: Activity) = | ||
| if notNull activity then | ||
| activity.Stop() | ||
|
|
||
| module internal Task = | ||
| open System.Threading.Tasks | ||
| open System.Diagnostics | ||
|
|
||
| /// Adds an exception to the activity if the task is faulted | ||
| let addActivityException (activity: Activity) (task: Task<'a>) = | ||
| if notNull activity && task.IsFaulted then | ||
| let exn = | ||
| if task.Exception.InnerExceptions.Count = 1 then | ||
| task.Exception.InnerExceptions[0] | ||
| else | ||
| task.Exception | ||
| Diagnostics.addActivityException exn activity | ||
| task | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
see also https://github.com/jet/equinox/blob/master/src/Equinox/Tracing.fs https://github.com/jet/equinox/blob/master/src/Equinox.MessageDb/Tracing.fs for other helper layout ideas
e.g. see how https://github.com/jet/equinox/blob/master/src/Equinox.MessageDb/MessageDb.fs#L251-L252 puts logic more in your face while still staying relatvely compact