tarantool / tarantool/tt

CLI: get metrics with request

Open
#4 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Go
Stars
113
Forks
18
Avg merge
4d 11h
Merged PRs (30d)
23

Description

As an operations engineer, I want to be able to easily collect instance metrics through the CLI. I need this to diagnose and contact support. I want to collect metrics from my work machine without having to shell the node running the Tarantool instance.

Acceptance Criteria:

  1. The administrator can view the list of instances on a specific node (similar to CLI: get coredumps with request)
  2. The administrator has the ability to request metrics from a specific instance. As a result of the command execution, the metrics provided by the [metrics] module (https://www.tarantool.io/ru/doc/latest/book/monitoring/metrics_reference/) are displayed on the console.
  3. The metrics module is used to collect metrics from the target instance. If the metrics module is not installed in the application running in the specified instance, then information about the metrics is not returned and an error is generated.
  4. [TBD] It is possible to return the core metrics available without the metrics module. See https://github.com/tarantool/tarantool/discussions/5833

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the existing CLI flow described in the linked “get coredumps with request” issue and the Tarantool metrics module reference. Define the instance-listing and metrics-request commands, including the error when the module is unavailable; the optional core-metrics behavior remains to be resolved from the linked discussion.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
cli, observability
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.