minor docs update

This commit is contained in:
Jonathan Shook 2021-04-06 16:14:25 -05:00
parent b8dab000e2
commit 65705ff9e2
2 changed files with 47 additions and 8 deletions

View File

@ -1,4 +1,4 @@
# nb -v http-graphql-cql-tabularrampup-cycles=1E6 main-cycles=1E9 stargate_host=my_stargate_host host=my_stargate_host auth_token=$AUTH_TOKEN # nb -v http-graphql-cql-tabular rampup-cycles=1E6 main-cycles=1E9 stargate_host=my_stargate_host host=my_stargate_host auth_token=$AUTH_TOKEN
description: | description: |
This workload emulates a time-series data model and access patterns. This workload emulates a time-series data model and access patterns.
This should be identical to the cql variant except for: This should be identical to the cql variant except for:

View File

@ -1,4 +1,5 @@
@startuml @startuml
title: Metrics Types and Scopes in SyncAction
Participant Input as i Participant Input as i
Participant Thread as t Participant Thread as t
@ -43,19 +44,57 @@ group TIMER strides
group HISTOGRAM tries group HISTOGRAM tries
loop over tries loop over tries
== for blocking APIs ==
group TIMERS\nexecute\nresult\nresult-success[result-success\nwhen no error]
a -> d: execute
activate d
a <- d: result
deactivate d
end
note right
When the underlying native
driver does not expose an async
API, execute and result must be updated
with the same measurements.
result-success contains the
same measurements as result,
but ONLY for non-exceptional
native driver results.
end note
== for async APIs ==
group TIMER execute group TIMER execute
a --> d: execute a -> d: execute
activate d activate d
a <-- d: future d -> future **: create
a <- d: future
deactivate d deactivate d
end end
group TIMERS result\n& result-success[result-success\nwhen no error] note right
a -> d: execute When the underlying native
activate d driver DOES expose an async
a <- d: future API, execute measures
deactivate d submission of an op to the
native driver, while result
measures the completion
of the op.
result-success contains the
same measurements as result,
but ONLY for non-exceptional
native driver results.
end note
group TIMERS\nresult\nresult-success[result-success\nwhen no error]
a -> future: get
activate future
a <- future: result
deactivate future
end end
end end