Skip to content

Commit

Permalink
Drop Mongo URI from logs (#952)
Browse files Browse the repository at this point in the history 
It also adds basic documentation about the collections in the exporters
and what they do.
  • Loading branch information
@idoqo
idoqo authored Nov 7, 2024
1 parent 1e917bf commit 6d48a93
Show file tree
Hide file tree
Showing 2 changed files with 38 additions and 21 deletions.
54 changes: 35 additions & 19 deletions REFERENCE.md
View file
Original file line number Diff line number Diff line change
@@ -1,36 +1,52 @@
# Usage Reference

## Flags
| Flag | Description | Example |
|-----------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------|
| -h, \-\-help | Show context-sensitive help | |
| --[no-]compatible-mode | Enable old mongodb-exporter compatible metrics | |
| --[no-]discovering-mode | Enable autodiscover collections | |
| --mongodb.collstats-colls | List of comma separared databases.collections to get $collStats | --mongodb.collstats-colls=db1,db2.col2 |
| --mongodb.indexstats-colls | List of comma separared databases.collections to get $indexStats | --mongodb.indexstats-colls=db1.col1,db2.col2 |
| --[no-]mongodb.direct-connect | Whether or not a direct connect should be made. Direct connections are not valid if multiple hosts are specified or an SRV URI is used | |
| --[no-]mongodb.global-conn-pool | Use global connection pool instead of creating new pool for each http request | |
| --mongodb.uri | MongoDB connection URI ($MONGODB_URI) | --mongodb.uri=mongodb://user:pass@127.0.0.1:27017/admin?ssl=true |
| --split-cluster | Whether to treat cluster members from the connection URI as separate targets |
| --web.listen-address | Address to listen on for web interface and telemetry | --web.listen-address=":9216" |
| --web.telemetry-path | Metrics expose path | --web.telemetry-path="/metrics" |
| --web.config | Path to the file having Prometheus TLS config for basic auth | --web.config=STRING |
| --web.timeout-offset | Offset to subtract from the timeout in seconds | --web.timeout-offset=1 |
| --log.level | Only log messages with the given severity or above. Valid levels: [debug, info, warn, error, fatal] | --log.level="error" |
| Flag | Description | Example |
|-----------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------|
| -h, \-\-help | Show context-sensitive help | |
| --[no-]compatible-mode | Enable old mongodb-exporter compatible metrics | |
| --[no-]discovering-mode | Enable autodiscover collections | |
| --mongodb.collstats-colls | List of comma separared databases.collections to get $collStats | --mongodb.collstats-colls=db1,db2.col2 |
| --mongodb.indexstats-colls | List of comma separared databases.collections to get $indexStats | --mongodb.indexstats-colls=db1.col1,db2.col2 |
| --[no-]mongodb.direct-connect | Whether or not a direct connect should be made. Direct connections are not valid if multiple hosts are specified or an SRV URI is used | |
| --[no-]mongodb.global-conn-pool | Use global connection pool instead of creating new pool for each http request | |
| --mongodb.uri | MongoDB connection URI ($MONGODB_URI) | --mongodb.uri=mongodb://user:pass@127.0.0.1:27017/admin?ssl=true |
| --split-cluster | Whether to treat cluster members from the connection URI as separate targets |
| --web.listen-address | Address to listen on for web interface and telemetry | --web.listen-address=":9216" |
| --web.telemetry-path | Metrics expose path | --web.telemetry-path="/metrics" |
| --web.config | Path to the file having Prometheus TLS config for basic auth | --web.config=STRING |
| --web.timeout-offset | Offset to subtract from the timeout in seconds | --web.timeout-offset=1 |
| --log.level | Only log messages with the given severity or above. Valid levels: [debug, info, warn, error, fatal] | --log.level="error" |
| --collector.diagnosticdata | Enable collecting metrics from getDiagnosticData |
| --collector.replicasetstatus | Enable collecting metrics from replSetGetStatus |
| --collector.dbstats | Enable collecting metrics from dbStats | |
| --collector.dbstatsfreestorage | Enable collecting freeStorage metrics from dbStats. If the instance has a large number of collections or indexes, obtaining free space usage data may cause processing delays | |
| --collector.dbstats | Enable collecting metrics from dbStats | |
| --collector.dbstatsfreestorage | Enable collecting freeStorage metrics from dbStats. If the instance has a large number of collections or indexes, obtaining free space usage data may cause processing delays | |
| --collector.topmetrics | Enable collecting metrics from top admin command |
| --collector.currentopmetrics | Enable collecting metrics from currentop admin command |
| --collector.indexstats | Enable collecting metrics from $indexStats |
| --collector.collstats | Enable collecting metrics from $collStats |
| --collect-all | Enable all collectors. Same as specifying all --collector.\<name\> |
| --collector.collstats-limit=0 | Disable collstats, dbstats, topmetrics and indexstats collector if there are more than \<n\> collections. 0=No limit |
| --collector.profile-time-ts=30 | Set time for scrape slow queries | This interval must be synchronized with the Prometheus scrape interval |
| --collector.profile-time-ts=30 | Set time for scrape slow queries. This interval must be synchronized with the Prometheus scrape interval | |
| --collector.profile | Enable collecting metrics from profile |
| --collector.shards | Enable collecting metrics related to Mongo shards |
| --collector.pbm | Enable collecting metrics related to Percona Backup for MongoDB |
| --collector.fcv | Enable Feature Compatibility Version collector |
| --metrics.overridedescendingindex | Enable descending index name override to replace -1 with _DESC |
| --version | Show version and exit |

## Collectors
| Collector Name | Description |
|--------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| dbstats | Collects metrics from dbStats. If the instance has a large number of collections or indexes, obtaining free space usage data may cause processing delays |
| dbstatsfreestorage | Collects freeStorage metrics from dbStats |
| topmetrics | Collects metrics from top admin command |
| currentopmetrics | Collects metrics from currentop admin command |
| indexstats | Collects metrics from $indexStats |
| collstats | Collects metrics from $collStats |
| profile | Collects metrics from profile |
| shards | Collects metrics related to Mongo shards |
| pbm | Collects metrics related to Percona Backup for MongoDB. It will disable [direct connection](https://www.mongodb.com/docs/drivers/node/current/fundamentals/connection/connect/#direct-connection) if needed. Note that this only affects the URI used by this collector and not affect the global MongoDB URI |
| fcv | Collects Feature Compatibility Version metrics |
| diagnosticdata | Collects metrics from getDiagnosticData |
| replicasetstatus | Collects metrics from replSetGetStatus |
5 changes: 3 additions & 2 deletions exporter/pbm_collector.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -54,9 +54,10 @@ func createPBMMetric(name, help string, value float64, labels map[string]string)
}

func newPbmCollector(ctx context.Context, client *mongo.Client, mongoURI string, logger *logrus.Logger) *pbmCollector {
// we can't get details of other cluster from PBM if directConnection is set to true,
// we can't get details of other cluster members from PBM if directConnection is set to true,
// we re-write it if that option is set (e.g from PMM).
if strings.Contains(mongoURI, "directConnection=true") {
logger.Debug("directConnection is enabled, will be disabled for PBM collector.")
mongoURI = strings.ReplaceAll(mongoURI, "directConnection=true", "directConnection=false")
}
return &pbmCollector{
Expand All @@ -83,7 +84,7 @@ func (p *pbmCollector) collect(ch chan<- prometheus.Metric) {
pbmEnabledMetric := 0
pbmClient, err := sdk.NewClient(p.ctx, p.mongoURI)
if err != nil {
logger.Errorf("failed to create PBM client from uri %s: %s", p.mongoURI, err.Error())
logger.Warnf("failed to create PBM client: %s", err.Error())
return
}
defer func() {
Expand Down

0 comments on commit 6d48a93

Please sign in to comment.