/usr/bin/mimirtool

usage: mimirtool [<flags>] <command> [<args> ...]

A command-line tool to manage Mimir and GEM.


Flags:
  --[no-]help                 Show context-sensitive help (also try --help-long and --help-man).
  --log.level="info"          set level of the logger
  --push-gateway.endpoint=PUSH-GATEWAY.ENDPOINT
                              url for the push-gateway to register metrics
  --push-gateway.job=PUSH-GATEWAY.JOB
                              job name to register metrics
  --push-gateway.interval=1m  interval to forward metrics to the push gateway

Commands:
help [<command>...]
    Show help.

acl generate-header --id=ID --rule=RULE
    Generate the header that needs to be passed to the datasource for setting ACLs.

alerts verify [<flags>]
    Verifies whether or not alerts in an Alertmanager cluster are deduplicated; useful for verifying
    correct configuration when transferring from Prometheus to Grafana Mimir alert evaluation.

alertmanager get --address=ADDRESS --id=ID [<flags>]
    Get the Alertmanager configuration that is currently in the Grafana Mimir Alertmanager.

alertmanager delete --address=ADDRESS --id=ID [<flags>]
    Delete the Alertmanager configuration that is currently in the Grafana Mimir Alertmanager.

alertmanager load --address=ADDRESS --id=ID [<flags>] <config> [<template-files>...]
    Load Alertmanager tenant configuration and template files into Grafana Mimir.

alertmanager migrate-utf8 [<flags>] <config> [<template-files>...]
    Migrate the Alertmanager tenant configuration for UTF-8.

alertmanager verify <config> [<template-files>...]
    Verify Alertmanager tenant configuration and template files.

alertmanager render --template.glob=TEMPLATE.GLOB --template.text=TEMPLATE.TEXT [<flags>]
    Render a given definition in a template file to standard output.

analyze prometheus --address=ADDRESS [<flags>]
    Take the metrics being used in Grafana and get the cardinality from a Prometheus.

analyze grafana --address=ADDRESS [<flags>]
    Analyze and output the metrics used in Grafana Dashboards.

analyze ruler --address=ADDRESS [<flags>]
    Analyze and extract the metrics that are used in Grafana Mimir rules

analyze dashboard [<flags>] <files>...
    Analyze and output the metrics used in Grafana dashboard files

analyze rule-file [<flags>] <files>...
    Analyze and output the metrics used in Prometheus rules files

backfill --address=ADDRESS --id=ID [<flags>] <block-dir>...
    Upload Prometheus TSDB blocks to Grafana Mimir compactor.

bucket-validation [<flags>]
    Validate that object store bucket works correctly.

config convert [<flags>]
    Convert configuration parameters (YAML and CLI flags) from Cortex v1.10.0 and above to Grafana
    Mimir v2.0.0 (default), and from Grafana Metrics Enterprise v1.7.0 to v2.0.0 (via --gem flag).

loadgen [<flags>]
    Simple load generator for Grafana Mimir.

partition-ring add-partition --partition.state=PARTITION.STATE --partition.id=PARTITION.ID --memberlist.join=MEMBERLIST.JOIN [<flags>]
    Forcefully add a partition to the ingest storage partition ring.

partition-ring remove-partition --partition.id=PARTITION.ID --memberlist.join=MEMBERLIST.JOIN [<flags>]
    Forcefully remove a partition from the ingest storage partition ring.

partition-ring add-owner --partition.id=PARTITION.ID --owner.id=OWNER.ID --memberlist.join=MEMBERLIST.JOIN [<flags>]
    Forcefully add an owner to the ingest storage partition ring.

partition-ring remove-owner --owner.id=OWNER.ID --memberlist.join=MEMBERLIST.JOIN [<flags>]
    Forcefully remove an owner from the ingest storage partition ring.

promql format [<flags>] <query>
    Format PromQL query with Prometheus' string formatter; wrap query in quotes for CLI parsing.

remote-read export --address=ADDRESS [<flags>]
    Export metrics remote read series into a local TSDB.

remote-read dump --address=ADDRESS [<flags>]
    Dump remote read series.

remote-read stats --address=ADDRESS [<flags>]
    Show statistic of remote read series.

rules list --address=ADDRESS --id=ID [<flags>]
    List the rules currently in the Grafana Mimir ruler.

rules print --address=ADDRESS --id=ID [<flags>]
    Print the rules currently in the Grafana Mimir ruler.

rules get --address=ADDRESS --id=ID [<flags>] <namespace> <group>
    Retrieve a rulegroup from the ruler.

rules delete --address=ADDRESS --id=ID [<flags>] <namespace> <group>
    Delete a rulegroup from the ruler.

rules load --address=ADDRESS --id=ID [<flags>] <rule-files>...
    Load a set of rules to a designated Grafana Mimir endpoint.

rules diff --address=ADDRESS --id=ID [<flags>] [<rule-files>...]
    Diff a set of rules to a designated Grafana Mimir endpoint.

rules sync --address=ADDRESS --id=ID [<flags>] [<rule-files>...]
    Sync a set of rules to a designated Grafana Mimir endpoint.

rules prepare [<flags>] [<rule-files>...]
    Modify a set of rules by including an specific label in aggregations.

rules lint [<flags>] [<rule-files>...]
    Format a set of rule files. Keys are sorted alphabetically, with 4 spaces as indentation,
    and PromQL expressions are formatted to a single line.

rules check [<flags>] [<rule-files>...]
    Run various best practice checks against rules.

rules delete-namespace --address=ADDRESS --id=ID [<flags>] <namespace>
    Delete a namespace from the ruler.

runtime-config validate [<flags>]
    Validate a runtime configuration file

validate alerts-file [<flags>] <files>...
    Load alert rule files and run validations on them.

version
    Get the version of the mimirtool CLI