Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

New Script: Prometheus Alertmanager #1272

Merged
merged 11 commits into from
Jan 9, 2025

Conversation

andygrunwald
Copy link
Contributor

@andygrunwald andygrunwald commented Jan 5, 2025

✍️ Description

This Pull Request provides a new Script: Prometheus Alertmanager.

This is the Alerting-Part of Prometheus, see https://prometheus.io/docs/alerting/latest/overview/

Prometheus is already part of this repository.



🛠️ Type of Change

Please check the relevant options:

  • Bug fix (non-breaking change that resolves an issue)
  • New feature (non-breaking change that adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change unexpectedly)
  • New script (a fully functional and thoroughly tested script or set of scripts)

✅ Prerequisites

The following steps must be completed for the pull request to be considered:

  • Self-review performed (I have reviewed my code to ensure it follows established patterns and conventions.)
  • Testing performed (I have thoroughly tested my changes and verified expected functionality.)
  • Documentation updated (I have updated any relevant documentation)

📋 Additional Information (optional)

This is a near copy of the Prometheus scripts.
The setup is 1:1 the same.

I would appreciate a proper testing from your side as well.
This is my first script contribution.

@andygrunwald andygrunwald requested a review from a team as a code owner January 5, 2025 21:04
@github-actions github-actions bot added new script A change that adds a new script website A change to the website labels Jan 5, 2025
@MickLesk
Copy link
Member

MickLesk commented Jan 5, 2025

Why not integrating in existing Prometheus Script als optional Installation/addon?

@andygrunwald
Copy link
Contributor Author

@MickLesk This would be an option. I didn't do this for two reasons:

  1. The standalone implementation was very straightforward
  2. The tooling around this ecosystem (Prometheus, Alertmanager, VictoriaMetrics with vmalert, vmagent or Thanos) is component-based by design with the usecase to "mix and match" like you want - This means there are usecases where you just want to have an Alertmanager without Prometheus (e.g., just to use the Alerting system, but not the metrics system)

Re 1): Is there an example script where I can get some orientation about how to do it?

Re 2): There might be an argument that those use cases would not use the Proxmox scripts, and this might be right. For a home lab to experiment, this may still be valid.


Should this stay standalone or should this be integrated into the Prometheus script?
My personal preference would be the standalone version, also due to maintenance.

ct/prometheus-alertmanager.sh Outdated Show resolved Hide resolved
install/prometheus-alertmanager-install.sh Outdated Show resolved Hide resolved
install/prometheus-alertmanager-install.sh Outdated Show resolved Hide resolved
install/prometheus-alertmanager-install.sh Outdated Show resolved Hide resolved
install/prometheus-alertmanager-install.sh Outdated Show resolved Hide resolved
install/prometheus-alertmanager-install.sh Outdated Show resolved Hide resolved
@andygrunwald
Copy link
Contributor Author

As far as I can see, the license is there, but the "Validate scripts" Github action still fails.

@andygrunwald
Copy link
Contributor Author

@michelroegl-brunner @MickLesk I rebased the branch against latest main and fixed all CI checks.

The CI check "Validate scripts / Check changed files (pull_request) " is failing, due to

data: {
      message: 'Resource not accessible by integration',
      documentation_url: 'https://docs.github.com/rest/issues/comments#create-an-issue-comment',
      status: '403'
    }

This seem to be unrelated to the change and rather related to the CI check itself.

@MickLesk MickLesk merged commit e592b80 into community-scripts:main Jan 9, 2025
3 of 4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
new script A change that adds a new script website A change to the website
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants