trim help strings to save a few bytes

This commit is contained in:
Kit Patella 2020-11-16 11:02:11 -08:00
parent 3966ecb02f
commit 15af5ead0b
18 changed files with 86 additions and 86 deletions

View File

@ -18,71 +18,71 @@ var CatalogCounters = []prometheus.CounterDefinition{
},
{
Name: []string{"client", "rpc", "error", "catalog_register"},
Help: "This increments whenever a Consul agent receives an RPC error for a catalog register request.",
Help: "Increments whenever a Consul agent receives an RPC error for a catalog register request.",
},
{
Name: []string{"client", "api", "success", "catalog_register"},
Help: "This increments whenever a Consul agent successfully responds to a catalog register request.",
Help: "Increments whenever a Consul agent successfully responds to a catalog register request.",
},
{
Name: []string{"client", "api", "catalog_deregister"},
Help: "This increments whenever a Consul agent receives a catalog deregister request.",
Help: "Increments whenever a Consul agent receives a catalog deregister request.",
},
{
Name: []string{"client", "api", "catalog_datacenters"},
Help: "This increments whenever a Consul agent receives a request to list datacenters in the catalog.",
Help: "Increments whenever a Consul agent receives a request to list datacenters in the catalog.",
},
{
Name: []string{"client", "rpc", "error", "catalog_deregister"},
Help: "This increments whenever a Consul agent receives an RPC error for a catalog deregister request.",
Help: "Increments whenever a Consul agent receives an RPC error for a catalog deregister request.",
},
{
Name: []string{"client", "api", "success", "catalog_nodes"},
Help: "This increments whenever a Consul agent successfully responds to a request to list nodes.",
Help: "Increments whenever a Consul agent successfully responds to a request to list nodes.",
},
{
Name: []string{"client", "rpc", "error", "catalog_nodes"},
Help: "This increments whenever a Consul agent receives an RPC error for a request to list nodes.",
Help: "Increments whenever a Consul agent receives an RPC error for a request to list nodes.",
},
{
Name: []string{"client", "api", "success", "catalog_deregister"},
Help: "This increments whenever a Consul agent successfully responds to a catalog deregister request.",
Help: "Increments whenever a Consul agent successfully responds to a catalog deregister request.",
},
{
Name: []string{"client", "rpc", "error", "catalog_datacenters"},
Help: "This increments whenever a Consul agent receives an RPC error for a request to list datacenters.",
Help: "Increments whenever a Consul agent receives an RPC error for a request to list datacenters.",
},
{
Name: []string{"client", "api", "success", "catalog_datacenters"},
Help: "This increments whenever a Consul agent successfully responds to a request to list datacenters.",
Help: "Increments whenever a Consul agent successfully responds to a request to list datacenters.",
},
{
Name: []string{"client", "api", "catalog_nodes"},
Help: "This increments whenever a Consul agent receives a request to list nodes from the catalog.",
Help: "Increments whenever a Consul agent receives a request to list nodes from the catalog.",
},
{
Name: []string{"client", "api", "catalog_services"},
Help: "This increments whenever a Consul agent receives a request to list services from the catalog.",
Help: "Increments whenever a Consul agent receives a request to list services from the catalog.",
},
{
Name: []string{"client", "rpc", "error", "catalog_services"},
Help: "This increments whenever a Consul agent receives an RPC error for a request to list services.",
Help: "Increments whenever a Consul agent receives an RPC error for a request to list services.",
},
{
Name: []string{"client", "api", "success", "catalog_services"},
Help: "This increments whenever a Consul agent successfully responds to a request to list services.",
Help: "Increments whenever a Consul agent successfully responds to a request to list services.",
},
{
Name: []string{"client", "api", "catalog_service_nodes"},
Help: "This increments whenever a Consul agent receives a request to list nodes offering a service.",
Help: "Increments whenever a Consul agent receives a request to list nodes offering a service.",
},
{
Name: []string{"client", "rpc", "error", "catalog_service_nodes"},
Help: "This increments whenever a Consul agent receives an RPC error for a request to list nodes offering a service.",
Help: "Increments whenever a Consul agent receives an RPC error for a request to list nodes offering a service.",
},
{
Name: []string{"client", "api", "success", "catalog_service_nodes"},
Help: "This increments whenever a Consul agent successfully responds to a request to list nodes offering a service.",
Help: "Increments whenever a Consul agent successfully responds to a request to list nodes offering a service.",
},
{
Name: []string{"client", "api", "error", "catalog_service_nodes"},
@ -90,15 +90,15 @@ var CatalogCounters = []prometheus.CounterDefinition{
},
{
Name: []string{"client", "api", "catalog_node_services"},
Help: "This increments whenever a Consul agent successfully responds to a request to list nodes offering a service.",
Help: "Increments whenever a Consul agent successfully responds to a request to list nodes offering a service.",
},
{
Name: []string{"client", "api", "success", "catalog_node_services"},
Help: "This increments whenever a Consul agent successfully responds to a request to list services in a node.",
Help: "Increments whenever a Consul agent successfully responds to a request to list services in a node.",
},
{
Name: []string{"client", "rpc", "error", "catalog_node_services"},
Help: "This increments whenever a Consul agent receives an RPC error for a request to list services in a node.",
Help: "Increments whenever a Consul agent receives an RPC error for a request to list services in a node.",
},
{
Name: []string{"client", "api", "catalog_node_service_list"},
@ -114,15 +114,15 @@ var CatalogCounters = []prometheus.CounterDefinition{
},
{
Name: []string{"client", "api", "catalog_gateway_services"},
Help: "This increments whenever a Consul agent receives a request to list services associated with a gateway.",
Help: "Increments whenever a Consul agent receives a request to list services associated with a gateway.",
},
{
Name: []string{"client", "rpc", "error", "catalog_gateway_services"},
Help: "This increments whenever a Consul agent receives an RPC error for a request to list services associated with a gateway.",
Help: "Increments whenever a Consul agent receives an RPC error for a request to list services associated with a gateway.",
},
{
Name: []string{"client", "api", "success", "catalog_gateway_services"},
Help: "This increments whenever a Consul agent successfully responds to a request to list services associated with a gateway.",
Help: "Increments whenever a Consul agent successfully responds to a request to list services associated with a gateway.",
},
}

View File

@ -16,7 +16,7 @@ import (
var ACLEndpointLegacySummaries = []prometheus.SummaryDefinition{
{
Name: []string{"acl", "apply"},
Help: "This measures the time it takes to complete an update to the ACL store.",
Help: "Measures the time it takes to complete an update to the ACL store.",
},
}

View File

@ -16,11 +16,11 @@ import (
var AutopilotGauges = []prometheus.GaugeDefinition{
{
Name: []string{"autopilot", "failure_tolerance"},
Help: "This tracks the number of voting servers that the cluster can lose while continuing to function.",
Help: "Tracks the number of voting servers that the cluster can lose while continuing to function.",
},
{
Name: []string{"autopilot", "healthy"},
Help: "This tracks the overall health of the local server cluster. 1 if all servers are healthy, 0 if one or more are unhealthy.",
Help: "Tracks the overall health of the local server cluster. 1 if all servers are healthy, 0 if one or more are unhealthy.",
},
}

View File

@ -21,7 +21,7 @@ import (
var CatalogCounters = []prometheus.CounterDefinition{
{
Name: []string{"catalog", "service", "query"},
Help: "This increments for each catalog query for the given service.",
Help: "Increments for each catalog query for the given service.",
},
{
Name: []string{"catalog", "connect", "query"},
@ -29,7 +29,7 @@ var CatalogCounters = []prometheus.CounterDefinition{
},
{
Name: []string{"catalog", "service", "query-tag"},
Help: "This increments for each catalog query for the given service with the given tag.",
Help: "Increments for each catalog query for the given service with the given tag.",
},
{
Name: []string{"catalog", "connect", "query-tag"},
@ -37,7 +37,7 @@ var CatalogCounters = []prometheus.CounterDefinition{
},
{
Name: []string{"catalog", "service", "query-tags"},
Help: "This increments for each catalog query for the given service with the given tags.",
Help: "Increments for each catalog query for the given service with the given tags.",
},
{
Name: []string{"catalog", "connect", "query-tags"},
@ -45,7 +45,7 @@ var CatalogCounters = []prometheus.CounterDefinition{
},
{
Name: []string{"catalog", "service", "not-found"},
Help: "This increments for each catalog query where the given service could not be found.",
Help: "Increments for each catalog query where the given service could not be found.",
},
{
Name: []string{"catalog", "connect", "not-found"},
@ -56,11 +56,11 @@ var CatalogCounters = []prometheus.CounterDefinition{
var CatalogSummaries = []prometheus.SummaryDefinition{
{
Name: []string{"catalog", "deregister"},
Help: "This measures the time it takes to complete a catalog deregister operation.",
Help: "Measures the time it takes to complete a catalog deregister operation.",
},
{
Name: []string{"catalog", "register"},
Help: "This measures the time it takes to complete a catalog register operation.",
Help: "Measures the time it takes to complete a catalog register operation.",
},
}

View File

@ -13,43 +13,43 @@ import (
var CommandsSummaries = []prometheus.SummaryDefinition{
{
Name: []string{"fsm", "register"},
Help: "This measures the time it takes to apply a catalog register operation to the FSM.",
Help: "Measures the time it takes to apply a catalog register operation to the FSM.",
},
{
Name: []string{"fsm", "deregister"},
Help: "This measures the time it takes to apply a catalog deregister operation to the FSM.",
Help: "Measures the time it takes to apply a catalog deregister operation to the FSM.",
},
{
Name: []string{"fsm", "kvs"},
Help: "This measures the time it takes to apply the given KV operation to the FSM.",
Help: "Measures the time it takes to apply the given KV operation to the FSM.",
},
{
Name: []string{"fsm", "session"},
Help: "This measures the time it takes to apply the given session operation to the FSM.",
Help: "Measures the time it takes to apply the given session operation to the FSM.",
},
{
Name: []string{"fsm", "acl"},
Help: "This measures the time it takes to apply the given ACL operation to the FSM.",
Help: "Measures the time it takes to apply the given ACL operation to the FSM.",
},
{
Name: []string{"fsm", "tombstone"},
Help: "This measures the time it takes to apply the given tombstone operation to the FSM.",
Help: "Measures the time it takes to apply the given tombstone operation to the FSM.",
},
{
Name: []string{"fsm", "coordinate", "batch-update"},
Help: "This measures the time it takes to apply the given batch coordinate update to the FSM.",
Help: "Measures the time it takes to apply the given batch coordinate update to the FSM.",
},
{
Name: []string{"fsm", "prepared-query"},
Help: "This measures the time it takes to apply the given prepared query update operation to the FSM.",
Help: "Measures the time it takes to apply the given prepared query update operation to the FSM.",
},
{
Name: []string{"fsm", "txn"},
Help: "This measures the time it takes to apply the given transaction update to the FSM.",
Help: "Measures the time it takes to apply the given transaction update to the FSM.",
},
{
Name: []string{"fsm", "autopilot"},
Help: "This measures the time it takes to apply the given autopilot update to the FSM.",
Help: "Measures the time it takes to apply the given autopilot update to the FSM.",
},
{
Name: []string{"consul", "fsm", "intention"},

View File

@ -16,7 +16,7 @@ import (
var SnapshotSummaries = []prometheus.SummaryDefinition{
{
Name: []string{"fsm", "persist"},
Help: "This measures the time it takes to persist the FSM to a raft snapshot.",
Help: "Measures the time it takes to persist the FSM to a raft snapshot.",
},
}

View File

@ -18,7 +18,7 @@ import (
var KVSummaries = []prometheus.SummaryDefinition{
{
Name: []string{"kvs", "apply"},
Help: "This measures the time it takes to complete an update to the KV store.",
Help: "Measures the time it takes to complete an update to the KV store.",
},
}

View File

@ -31,15 +31,15 @@ import (
var LeaderSummaries = []prometheus.SummaryDefinition{
{
Name: []string{"leader", "barrier"},
Help: "This measures the time spent waiting for the raft barrier upon gaining leadership.",
Help: "Measures the time spent waiting for the raft barrier upon gaining leadership.",
},
{
Name: []string{"leader", "reconcileMember"},
Help: "This measures the time spent updating the raft store for a single serf member's information.",
Help: "Measures the time spent updating the raft store for a single serf member's information.",
},
{
Name: []string{"leader", "reapTombstones"},
Help: "This measures the time spent clearing tombstones.",
Help: "Measures the time spent clearing tombstones.",
},
}

View File

@ -19,19 +19,19 @@ import (
var PreparedQuerySummaries = []prometheus.SummaryDefinition{
{
Name: []string{"prepared-query", "apply"},
Help: "This measures the time it takes to apply a prepared query update.",
Help: "Measures the time it takes to apply a prepared query update.",
},
{
Name: []string{"prepared-query", "explain"},
Help: "This measures the time it takes to process a prepared query explain request.",
Help: "Measures the time it takes to process a prepared query explain request.",
},
{
Name: []string{"prepared-query", "execute"},
Help: "This measures the time it takes to process a prepared query execute request.",
Help: "Measures the time it takes to process a prepared query execute request.",
},
{
Name: []string{"prepared-query", "execute_remote"},
Help: "This measures the time it takes to process a prepared query execute request that was forwarded to another datacenter.",
Help: "Measures the time it takes to process a prepared query execute request that was forwarded to another datacenter.",
},
}

View File

@ -35,41 +35,41 @@ import (
var RPCCounters = []prometheus.CounterDefinition{
{
Name: []string{"rpc", "accept_conn"},
Help: "This increments when a server accepts an RPC connection.",
Help: "Increments when a server accepts an RPC connection.",
},
{
Name: []string{"rpc", "raft_handoff"},
Help: "This increments when a server accepts a Raft-related RPC connection.",
Help: "Increments when a server accepts a Raft-related RPC connection.",
},
{
Name: []string{"rpc", "request_error"},
Help: "This increments when a server returns an error from an RPC request.",
Help: "Increments when a server returns an error from an RPC request.",
},
{
Name: []string{"rpc", "request"},
Help: "This increments when a server receives a Consul-related RPC request.",
Help: "Increments when a server receives a Consul-related RPC request.",
},
{
Name: []string{"rpc", "cross-dc"},
Help: "This increments when a server sends a (potentially blocking) cross datacenter RPC query.",
Help: "Increments when a server sends a (potentially blocking) cross datacenter RPC query.",
},
{
Name: []string{"rpc", "query"},
Help: "This increments when a server receives a new blocking RPC request, indicating the rate of new blocking query calls.",
Help: "Increments when a server receives a new blocking RPC request, indicating the rate of new blocking query calls.",
},
}
var RPCGauges = []prometheus.GaugeDefinition{
{
Name: []string{"rpc", "queries_blocking"},
Help: "This shows the current number of in-flight blocking queries the server is handling.",
Help: "Shows the current number of in-flight blocking queries the server is handling.",
},
}
var RPCSummaries = []prometheus.SummaryDefinition{
{
Name: []string{"rpc", "consistentRead"},
Help: "This measures the time spent confirming that a consistent read can be performed.",
Help: "Measures the time spent confirming that a consistent read can be performed.",
},
}

View File

@ -15,7 +15,7 @@ import (
var SegmentOSSSummaries = []prometheus.SummaryDefinition{
{
Name: []string{"leader", "reconcile"},
Help: "This measures the time spent updating the raft store from the serf member information.",
Help: "Measures the time spent updating the raft store from the serf member information.",
},
}

View File

@ -17,11 +17,11 @@ import (
var SessionEndpointSummaries = []prometheus.SummaryDefinition{
{
Name: []string{"session", "apply"},
Help: "This measures the time spent applying a session update.",
Help: "Measures the time spent applying a session update.",
},
{
Name: []string{"session", "renew"},
Help: "This measures the time spent renewing a session.",
Help: "Measures the time spent renewing a session.",
},
}

View File

@ -12,7 +12,7 @@ import (
var SessionGauges = []prometheus.GaugeDefinition{
{
Name: []string{"session_ttl", "active"},
Help: "This tracks the active number of sessions being tracked.",
Help: "Tracks the active number of sessions being tracked.",
},
{
Name: []string{"raft", "applied_index"},
@ -27,7 +27,7 @@ var SessionGauges = []prometheus.GaugeDefinition{
var SessionSummaries = []prometheus.SummaryDefinition{
{
Name: []string{"session_ttl", "invalidate"},
Help: "This measures the time spent invalidating an expired session.",
Help: "Measures the time spent invalidating an expired session.",
},
}

View File

@ -15,11 +15,11 @@ import (
var TxnSummaries = []prometheus.SummaryDefinition{
{
Name: []string{"txn", "apply"},
Help: "This measures the time spent applying a transaction operation.",
Help: "Measures the time spent applying a transaction operation.",
},
{
Name: []string{"txn", "read"},
Help: "This measures the time spent returning a read transaction.",
Help: "Measures the time spent returning a read transaction.",
},
}

View File

@ -16,15 +16,15 @@ import (
var Gauges = []prometheus.GaugeDefinition{
{
Name: []string{"consul", "state", "nodes"},
Help: "This measures the current number of nodes registered with Consul. It is only emitted by Consul servers. Added in v1.9.0.",
Help: "Measures the current number of nodes registered with Consul. It is only emitted by Consul servers. Added in v1.9.0.",
},
{
Name: []string{"consul", "state", "services"},
Help: "This measures the current number of unique services registered with Consul, based on service name. It is only emitted by Consul servers. Added in v1.9.0.",
Help: "Measures the current number of unique services registered with Consul, based on service name. It is only emitted by Consul servers. Added in v1.9.0.",
},
{
Name: []string{"consul", "state", "service_instances"},
Help: "This measures the current number of unique services registered with Consul, based on service name. It is only emitted by Consul servers. Added in v1.9.0.",
Help: "Measures the current number of unique services registered with Consul, based on service name. It is only emitted by Consul servers. Added in v1.9.0.",
},
}

View File

@ -31,18 +31,18 @@ import (
var DNSCounters = []prometheus.CounterDefinition{
{
Name: []string{"dns", "stale_queries"},
Help: "This increments when an agent serves a query within the allowed stale threshold.",
Help: "Increments when an agent serves a query within the allowed stale threshold.",
},
}
var DNSSummaries = []prometheus.SummaryDefinition{
{
Name: []string{"dns", "ptr_query"},
Help: "This measures the time spent handling a reverse DNS query for the given node.",
Help: "Measures the time spent handling a reverse DNS query for the given node.",
},
{
Name: []string{"dns", "domain_query"},
Help: "This measures the time spent handling a domain query for the given node.",
Help: "Measures the time spent handling a domain query for the given node.",
},
}

View File

@ -13,37 +13,37 @@ import (
var StatsGauges = []prometheus.GaugeDefinition{
{
Name: []string{"grpc", "server", "connections"},
Help: "This metric measures the number of active gRPC connections open on the server.",
Help: "Measures the number of active gRPC connections open on the server.",
},
{
Name: []string{"grpc", "client", "connections"},
Help: "This metric measures the number of active gRPC connections open from the client agent to any Consul servers.",
Help: "Measures the number of active gRPC connections open from the client agent to any Consul servers.",
},
{
Name: []string{"grpc", "server", "streams"},
Help: "This metric measures the number of active gRPC streams handled by the server.",
Help: "Measures the number of active gRPC streams handled by the server.",
},
}
var StatsCounters = []prometheus.CounterDefinition{
{
Name: []string{"grpc", "client", "request", "count"},
Help: "This metric counts the number of gRPC requests made by the client agent to a Consul server.",
Help: "Counts the number of gRPC requests made by the client agent to a Consul server.",
},
{
Name: []string{"grpc", "server", "request", "count"},
Help: "This metric counts the number of gRPC requests received by the server.",
Help: "Counts the number of gRPC requests received by the server.",
},
{
Name: []string{"grpc", "client", "connection", "count"},
Help: "This metric counts the number of new gRPC connections opened by the client agent to a Consul server.",
Help: "Counts the number of new gRPC connections opened by the client agent to a Consul server.",
},
{
Name: []string{"grpc", "server", "connection", "count"},
Help: "This metric counts the number of new gRPC connections received by the server.",
Help: "Counts the number of new gRPC connections received by the server.",
},
{
Name: []string{"grpc", "server", "stream", "count"},
Help: "This metric counts the number of new gRPC streams received by the server.",
Help: "Counts the number of new gRPC streams received by the server.",
},
}

View File

@ -23,27 +23,27 @@ import (
var StateCounters = []prometheus.CounterDefinition{
{
Name: []string{"acl", "blocked", "service", "registration"},
Help: "This increments whenever a registration fails for a service (blocked by an ACL)",
Help: "Increments whenever a registration fails for a service (blocked by an ACL)",
},
{
Name: []string{"acl", "blocked", "service", "deregistration"},
Help: "This increments whenever a deregistration fails for a service (blocked by an ACL)",
Help: "Increments whenever a deregistration fails for a service (blocked by an ACL)",
},
{
Name: []string{"acl", "blocked", "check", "registration"},
Help: "This increments whenever a registration fails for a check (blocked by an ACL)",
Help: "Increments whenever a registration fails for a check (blocked by an ACL)",
},
{
Name: []string{"acl", "blocked", "check", "deregistration"},
Help: "This increments whenever a deregistration fails for a check (blocked by an ACL)",
Help: "Increments whenever a deregistration fails for a check (blocked by an ACL)",
},
{
Name: []string{"acl", "blocked", "node", "registration"},
Help: "This increments whenever a registration fails for a node (blocked by an ACL)",
Help: "Increments whenever a registration fails for a node (blocked by an ACL)",
},
{
Name: []string{"acl", "blocked", "node", "deregistration"},
Help: "This increments whenever a deregistration fails for a node (blocked by an ACL)",
Help: "Increments whenever a deregistration fails for a node (blocked by an ACL)",
},
}