@@ -50,9 +50,9 @@ Aerospike blackbox probe
5050
5151Flags:
5252 -h, --help Show context-sensitive help (also try --help-long and --help-man).
53- --web.listen-address="0.0.0.0:8080"
53+ --web.listen-address="0.0.0.0:8080"
5454 Address to listen on for UI, API, and telemetry.
55- --config.path="config.yaml"
55+ --config.path="config.yaml"
5656 Path to the probe configuration file
5757 --log.level=info Only log messages with the given severity or above. One of: [debug, info, warn, error]
5858 --log.format=logfmt Output format of log messages. One of: [logfmt, json]
@@ -82,27 +82,27 @@ The prober will schedule checks (either cluster or node level) for each endpoint
8282
8383## Conventions
8484
85- Metrics should use seconds as unit or prefix with the unit (` _ms ` )
85+ Metrics should use seconds as unit or prefix with the unit (` _ms ` )
8686
8787
8888## Implementations
8989
90- Probes are defined in the probes /\< name of db\> directory.
90+ Probes are defined in the cmd /\< name of db\> directory.
9191The probes have to define 3 things:
9292
9393### Endpoints
9494
95- A implementation of the ` toplogy.ProbeableEndpoint ` . It contains the client
95+ A implementation of the ` toplogy.ProbeableEndpoint ` . It contains the client
9696(and everything necessary) to connect to the database. State, locks or
9797connections should not be shared between endpoints as it may affect recorded
9898latencies.
9999
100- See [ probes /aerospike/endpoint.go] ( probes /aerospike/endpoint.go) for an example
100+ See [ cmd /aerospike/endpoint.go] ( cmd /aerospike/endpoint.go) for an example
101101
102102### Endpoint builder
103103
104104The discovery is responsible for creating the topology. When creating a
105- discoverer, a builder function should be provided:
105+ discoverer, a builder function should be provided:
106106` topologyBuilderFn func(log.Logger, []ServiceEntry) (topology.ClusterMap, error) `
107107This function takes all the service entries (services found by the service
108108discovery) and return a topology. A generic version of this function is
@@ -116,7 +116,7 @@ GetGenericTopologyBuilder(
116116` ClusterFn ` should generate a cluster level endpoint
117117` NodeFn ` should generate a node level endpoint
118118
119- See [ probes /aerospike/discovery.go] ( probes /aerospike/discovery.go) for an example
119+ See [ cmd /aerospike/discovery.go] ( cmd /aerospike/discovery.go) for an example
120120
121121### Checks
122122
@@ -132,4 +132,4 @@ p.RegisterNewClusterCheck(scheduler.Check{
132132```
133133` scheduler.Noop ` is a placeholder function
134134
135- See [ probes /aerospike/main.go] ( probes /aerospike/main.go) for an example
135+ See [ cmd /aerospike/main.go] ( cmd /aerospike/main.go) for an example
0 commit comments