/usr/bin/profilecli

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

Tooling for Grafana Pyroscope, the continuous profiling aggregation system.


Flags:
  -h, --[no-]help     Show context-sensitive help (also try --help-long and --help-man).
      --[no-]version  Show application version.
  -v, --[no-]verbose  Enable verbose logging.

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

admin blocks list [<flags>]
    List blocks.

admin blocks compact [<flags>] <from> <dest>
    Compact blocks.

admin blocks query series [<flags>]
    Request series labels on local/remote blocks.

admin blocks query profile [<flags>]
    Request merged profile on local/remote block.

admin parquet inspect <file>...
    Inspect a parquet file's structure.

admin tsdb series <file>...
    dump series in an TSDB index file.

admin bucket web [<flags>]
    Run the web tool for visualizing blocks in object-store buckets.

admin bucket list-v2-blocks [<flags>]
    List Pyroscope v2 segments and blocks in object-store buckets.

admin bucket inspect-v2-blocks [<flags>] <path>...
    Inspect Pyroscope v2 segments and blocks in object-store buckets.

admin raft info [<flags>]
    Print info about a Raft node.

admin v2-migration bucket-cleanup [<flags>]
    Clean up v1 artificats from data bucket.

admin kube-proxy [<flags>]
    Start a reverse proxy unifying all the micro services in a single endpoint.

query profile [<flags>]
    Request merged profile.

query go-pgo [<flags>]
    Request profile for Go PGO.

query series [<flags>]
    Request series labels.

query label-values-cardinality [<flags>]
    Request label values cardinality.

query top [<flags>]
    List top N label values by total value for a time window.

query exemplars profile [<flags>]
    List profile exemplars for a time window.

query exemplars span [<flags>]
    List span exemplars for a time window. Requires span-aware SDK instrumentation. V2 only.

query-tracer [<flags>]
    Analyze query traces.

upload [<flags>] <path>...
    Upload profile(s).

canary-exporter [<flags>]
    Run the canary exporter.

ready [<flags>]
    Check Pyroscope health.

source-code coverage --profile=PROFILE [<flags>]
    Measure the coverage of .pyroscope.yaml source code mappings for translating function
    names/paths from a pprof profile to VCS source files.

recording-rules list
    List recording rules. When accessing a Grafana Cloud datasource, requires a token with the
    "profiles-config:read" scope.

recording-rules get [<flags>] <rule_id>
    Get a specific recording rule. When accessing a Grafana Cloud datasource, requires a token with
    the "profiles-config:read" scope.

recording-rules create --file=FILE
    Create a recording rule. When accessing a Grafana Cloud datasource, requires a token with the
    "profiles-config:write" scope.

      Example:
      	# Create a rule that records the total CPU usage of the garbage collector function for every service in the "emea" region:
      	profilecli recording-rules create -f rule.yaml

      	# rule.yaml:
      	matchers:
      	  - '{ __profile_type__="process_cpu:cpu:nanoseconds:cpu:nanoseconds", region="emea"}'
      	metric_name: profiles_recorded_cpu_usage_function_total_gc_nanoseconds
      	group_by:
      	  - service_name
      	function_name: runtime.gcBgMarkWorker

recording-rules delete <rule_id>
    Delete a recording rule. When accessing a Grafana Cloud datasource, requires a token with the
    "profiles-config:write" scope.

debuginfo upload [<flags>] <path>
    Upload debuginfo.

debuginfo list [<flags>]
    List debuginfo.

debuginfo delete [<flags>] <gnu-build-id>
    Delete debuginfo by GNU build ID.