opensearch-project/opensearch-prometheus-exporter

Implement new tests to improve coverage of exposed metrics.

Open

#219 opened on Aug 31, 2023

View on GitHubContributor guide
 (0 comments) (0 reactions) (0 assignees)Java (93 forks)github user discovery
good first issue

Repository metrics

Stars
 (208 stars)
PR merge metrics
 (Avg merge 1d 7h) (10 merged PRs in 30d)

Description

When new metrics are introduced in OpenSearch we do not learn about this when upgrading. There is simply no logic to automatically detect this and those new metric stay unnoticed.

To improve this situation we can implement a new set of tests that will pull JSON data containing metrics and count number of members of the JSON structure and compare to hard-coded numbers. This way we can easily learn that something new was added. Theoretically we can miss the case when one metric is removed and one added (the count will be the same) but this will be caught by other existing tests that "call specific metrics by name".

Contributor guide

Research direction
Examine the existing test suite to understand how metrics are exposed as JSON. Identify the JSON structure for new metrics and implement tests that compare the number of JSON members to hard coded values.
Tech stack
java
Domain
backendtesting qa
Issue type
Test
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
JavaTesting
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75