mirror of
https://github.com/digital-asset/daml.git
synced 2024-11-13 00:16:19 +03:00
Update metrics documentation [DPP-1078] (#14174)
Correct metrics documentation shipped with the sdk * Remove references to obsolete metrics for participant-side de-duplication * Correct the names of the connection pool metrics * Add a mention about internal service metrics * Correct the name for the string interning metric * Remove obsolete sandbox server role CHANGELOG_BEGIN Correct the name for the string interning metric from daml_index_db_loadStringInterningEntries to daml_index_db_load_string_interning_entries CHANGELOG_END
This commit is contained in:
parent
479d605072
commit
9c5c72a2fd
@ -306,20 +306,15 @@ that can be particularly important to track. Note that not
|
||||
all the following metrics are available unless you run the
|
||||
sandbox with a PostgreSQL backend.
|
||||
|
||||
``daml.commands.deduplicated_commands``
|
||||
---------------------------------------
|
||||
|
||||
A meter. Number of deduplicated commands.
|
||||
|
||||
``daml.commands.delayed_submissions``
|
||||
-------------------------------------
|
||||
|
||||
A meter. Number of delayed submissions (submission who have been
|
||||
A meter. Number of delayed submissions (submission that have been
|
||||
evaluated to transaction with a ledger time farther in
|
||||
the future than the expected latency).
|
||||
|
||||
``daml.commands.failed_command_interpretation``
|
||||
-----------------------------------------------
|
||||
``daml.commands.failed_command_interpretations``
|
||||
------------------------------------------------
|
||||
|
||||
A meter. Number of commands that have been deemed unacceptable
|
||||
by the interpreter and thus rejected (e.g. double spends)
|
||||
@ -422,8 +417,8 @@ mismatching ledger effective time.
|
||||
A timer. Time spent interpreting a valid command into a transaction
|
||||
ready to be submitted to the ledger for finalization.
|
||||
|
||||
``daml.index.db.connection.sandbox.pool``
|
||||
-----------------------------------------
|
||||
``daml.index.db.connection.api.server.pool``
|
||||
--------------------------------------------
|
||||
|
||||
This namespace holds a number of interesting metrics about the
|
||||
connection pool used to communicate with the persistent store
|
||||
@ -431,18 +426,12 @@ that underlies the index.
|
||||
|
||||
These metrics include:
|
||||
|
||||
- ``daml.index.db.connection.sandbox.pool.Wait`` (timer): time spent waiting to acquire a connection
|
||||
- ``daml.index.db.connection.sandbox.pool.Usage`` (histogram): time spent using each acquired connection
|
||||
- ``daml.index.db.connection.sandbox.pool.TotalConnections`` (gauge): number or total connections
|
||||
- ``daml.index.db.connection.sandbox.pool.IdleConnections`` (gauge): number of idle connections
|
||||
- ``daml.index.db.connection.sandbox.pool.ActiveConnections`` (gauge): number of active connections
|
||||
- ``daml.index.db.connection.sandbox.pool.PendingConnections`` (gauge): number of threads waiting for a connection
|
||||
|
||||
``daml.index.db.deduplicate_command``
|
||||
-------------------------------------
|
||||
|
||||
A timer. Time spent persisting deduplication information to ensure the
|
||||
continued working of the deduplication mechanism across restarts.
|
||||
- ``daml.index.db.connection.api.server.pool.Wait`` (timer): time spent waiting to acquire a connection
|
||||
- ``daml.index.db.connection.api.server.pool.Usage`` (histogram): time spent using each acquired connection
|
||||
- ``daml.index.db.connection.api.server.pool.TotalConnections`` (gauge): number or total connections
|
||||
- ``daml.index.db.connection.api.server.pool.IdleConnections`` (gauge): number of idle connections
|
||||
- ``daml.index.db.connection.api.server.pool.ActiveConnections`` (gauge): number of active connections
|
||||
- ``daml.index.db.connection.api.server.pool.PendingConnections`` (gauge): number of threads waiting for a connection
|
||||
|
||||
``daml.index.db.get_active_contracts``
|
||||
--------------------------------------
|
||||
@ -568,20 +557,6 @@ contracts involved to ensure causal monotonicity.
|
||||
A database metric. Time to lookup a single transaction tree by identifier
|
||||
to be served by the transaction service.
|
||||
|
||||
``daml.index.db.remove_expired_deduplication_data``
|
||||
---------------------------------------------------
|
||||
|
||||
A database metric. Time spent removing deduplication information after the expiration
|
||||
of the deduplication window. Deduplication information is persisted to
|
||||
ensure the continued working of the deduplication mechanism across restarts.
|
||||
|
||||
``daml.index.db.stop_deduplicating_command``
|
||||
--------------------------------------------
|
||||
|
||||
A database metric. Time spent removing deduplication information after the failure of a
|
||||
command. Deduplication information is persisted to ensure the continued
|
||||
working of the deduplication mechanism across restarts.
|
||||
|
||||
``daml.index.db.store_configuration_entry``
|
||||
-------------------------------------------
|
||||
|
||||
@ -628,6 +603,23 @@ As in the following example:
|
||||
Single call services return the time to serve the request,
|
||||
streaming services measure the time to return the first response.
|
||||
|
||||
``daml.services``
|
||||
-----------------
|
||||
|
||||
Every metrics under this namespace is a timer, one for each
|
||||
endpoint exposed by the index, read or write service. Metrics
|
||||
are in the format:
|
||||
|
||||
``daml.services.service_name.service_endpoint``
|
||||
|
||||
The following example demonstrates a metric for transactions
|
||||
submitted over the write service:
|
||||
|
||||
``daml.services.write.submit_transaction``
|
||||
|
||||
Single call services return the time to serve the request,
|
||||
streaming services measure the time to return the first response.
|
||||
|
||||
``jvm``
|
||||
-------
|
||||
|
||||
|
@ -505,7 +505,7 @@ final class Metrics(val registry: MetricRegistry) {
|
||||
"get_contract_state_events"
|
||||
)
|
||||
val loadStringInterningEntries: DatabaseMetrics = createDbMetrics(
|
||||
"loadStringInterningEntries"
|
||||
"load_string_interning_entries"
|
||||
)
|
||||
|
||||
val meteringAggregator: DatabaseMetrics = createDbMetrics("metering_aggregator")
|
||||
|
@ -27,10 +27,6 @@ object ServerRole {
|
||||
override val threadPoolSuffix: String = "migrations"
|
||||
}
|
||||
|
||||
object Sandbox extends ServerRole {
|
||||
override val threadPoolSuffix: String = "sandbox"
|
||||
}
|
||||
|
||||
object ReadIndexMetadata extends ServerRole {
|
||||
override val threadPoolSuffix: String = "dump-index-metadata"
|
||||
}
|
||||
|
Loading…
Reference in New Issue
Block a user