diff --git a/guides/telemetry.md b/guides/telemetry.md index 8a72c7e7..b559c299 100644 --- a/guides/telemetry.md +++ b/guides/telemetry.md @@ -6,15 +6,15 @@ A telemetry span of a full scenario execution globally (i.e. the exported `init/ ```erlang event_name: [amoc, scenario, run, _] measurements: #{} %% As described in `telemetry:span/3` -metadata: #{scenario => module()} %% Plus as described in `telemetry:span/3` +metadata: #{scenario := module()} %% Plus as described in `telemetry:span/3` ``` A telemetry span of a full scenario execution for a user (i.e. the exported `start/1,2` function): ```erlang event_name: [amoc, scenario, user, _] measurements: #{} %% As described in `telemetry:span/3` -metadata: #{scenario => module(), - user_id => non_neg_integer()} %% Plus as described in `telemetry:span/3` +metadata: #{scenario := module(), + user_id := non_neg_integer()} %% Plus as described in `telemetry:span/3` ``` ## Controller @@ -22,8 +22,8 @@ metadata: #{scenario => module(), Indicates the number of users manually added or removed ```erlang event_name: [amoc, controller, users] -measurements: #{count => non_neg_integer()} -metadata: #{monotonic_time => integer(), scenario => module(), type => add | remove} +measurements: #{count := non_neg_integer()} +metadata: #{monotonic_time := integer(), scenario := module(), type := add | remove} ``` ## Throttle @@ -33,8 +33,8 @@ metadata: #{monotonic_time => integer(), scenario => module(), type => add | rem Raised when a throttle mechanism is initialised. ```erlang event_name: [amoc, throttle, init] -measurements: #{count => 1} -metadata: #{monotonic_time => integer(), name => atom()} +measurements: #{count := 1} +metadata: #{monotonic_time := integer(), name := atom()} ``` ### Rate @@ -43,8 +43,8 @@ Raised when a throttle mechanism is initialised or its configured rate is change This event is raised only on the master node. ```erlang event_name: [amoc, throttle, rate] -measurements: #{rate => non_neg_integer()} -metadata: #{monotonic_time => integer(), name => atom()} +measurements: #{rate := non_neg_integer()} +metadata: #{monotonic_time := integer(), name := atom(), msg => binary()} ``` ### Request @@ -52,8 +52,8 @@ metadata: #{monotonic_time => integer(), name => atom()} Raised when a process client requests to be allowed pass through a throttled mechanism. ```erlang event_name: [amoc, throttle, request] -measurements: #{count => 1} -metadata: #{monotonic_time => integer(), name => atom()} +measurements: #{count := 1} +metadata: #{monotonic_time := integer(), name := atom()} ``` ### Execute @@ -61,8 +61,8 @@ metadata: #{monotonic_time => integer(), name => atom()} Raised when a process client is allowed to execute after a throttled mechanism. ```erlang event_name: [amoc, throttle, execute] -measurements: #{count => 1} -metadata: #{monotonic_time => integer(), name => atom()} +measurements: #{count := 1} +metadata: #{monotonic_time := integer(), name := atom()} ``` ## Coordinator @@ -72,6 +72,6 @@ Indicates when a coordinating event was raised, like a process being added for c ### Event ```erlang event_name: [amoc, coordinator, start | stop | add | reset | timeout] -measurements: #{count => 1} -metadata: #{monotonic_time => integer(), name => atom()} +measurements: #{count := 1} +metadata: #{monotonic_time := integer(), name := atom()} ```