gatus icon indicating copy to clipboard operation
gatus copied to clipboard

feat: add ability to add labels/tags to endpoints

Open FlorianBorn opened this issue 9 months ago • 2 comments

Describe the feature request

I would like Gatus to support adding tags or labels to each configured endpoint. These tags should at least be exposed in the API, allowing users to categorize and filter endpoints more effectively. Ideally, tags could be defined within the configuration for each endpoint and retrieved through API responses.

Example Configuration:

endpoints:
  - name: Example Service
    url: https://example.com/health
    tags:
      - critical
      - internal

Example API Response:

{
  "name": "Example Service",
  "group: "Example Group",
  "tags": ["critical", "internal"]
  ...
}

Why do you personally want this feature to be implemented?

We would like to pass additional information to the team retrieving endpoint statuses over the API, making it easier for them to understand the purpose and importance of each service.

Categorization: I can categorize endpoints by environment (e.g., production, staging), importance (critical, non-critical), or team ownership (backend, frontend).

Filtering: It would be easier to filter API responses based on relevant tags when integrating with dashboards or automation tools.

Improved Reporting: Tags can be used to group services in visualizations, making it easier to analyze overall system health.

How long have you been using this project?

4 month

Additional information

No response

FlorianBorn avatar Apr 02 '25 07:04 FlorianBorn

Great idea!

TwiN avatar Apr 02 '25 11:04 TwiN

I, too, would like this for filtering. Alternatively, nested groups, though that doesn't achieve the same decoupling as tags.

petersrinivasan avatar Oct 04 '25 01:10 petersrinivasan