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

feat(bazarr) Adding exportarr to expose metrics to prometheus #14761

Merged
merged 10 commits into from
Dec 20, 2023

Conversation

RobReus
Copy link
Contributor

@RobReus RobReus commented Nov 17, 2023

Description
This adds exportarr to the bazarr application as bazarr is supported by exportarr. This allows the user to have prometheus scrape for bazarr metrics.

⚙️ Type of change

  • ⚙️ Feature/App addition
  • 🪛 Bugfix
  • ⚠️ Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • 🔃 Refactor of current code

🧪 How Has This Been Tested?
Created a personal catalog which I added to TrueNAS. I then installed this app sourced from this catalog to ensure the questions + answers, and actual installation works.

📃 Notes:
Exportarr for bazarr does not work without having the API key to access bazarr set. I have added this as a question to the metrics part (see below screenshot). Is this an acceptable way of doing this, or should it be done differently? Unfortunately bazarr does not support setting the api key via environment variables, so enabling metrics for a new deployment requires 2 deployments. The first one without metrics enabled to bootstrap bazarr, and then a second one to enable metrics and set the api key.

2023-11-20_12-26

Also, due to a bug in exportarr (onedr0p/exportarr#244), exportarr does not work when there are no series added/sonarr is not configured. Should this be mentioned anywhere to the users of this chart?

✔️ Checklist:

  • ⚖️ My code follows the style guidelines of this project
  • 👀 I have performed a self-review of my own code
  • #️⃣ I have commented my code, particularly in hard-to-understand areas
  • 📄 I have made corresponding changes to the documentation
  • ⚠️ My changes generate no new warnings
  • 🧪 I have added tests to this description that prove my fix is effective or that my feature works
  • ⬆️ I increased versions for any altered app according to semantic versioning

➕ App addition

If this PR is an app addition please make sure you have done the following.

  • 🪞 I have opened a PR on truecharts/containers adding the container to TrueCharts mirror repo.
  • 🖼️ I have added an icon in the Chart's root directory called icon.png

Please don't blindly check all the boxes. Read them and only check those that apply.
Those checkboxes are there for the reviewer to see what is this all about and
the status of this PR with a quick glance.

@RobReus RobReus requested review from PrivatePuffin and a team as code owners November 17, 2023 14:28
@RobReus RobReus changed the title feat(bazarr) Adding exportarr to expose metrics to prometheus WIP feat(bazarr) Adding exportarr to expose metrics to prometheus Nov 19, 2023
Copy link

gitguardian bot commented Nov 20, 2023

⚠️ GitGuardian has uncovered 1 secret following the scan of your pull request.

Please consider investigating the findings and remediating the incidents. Failure to do so may lead to compromising the associated services or software components.

🔎 Detected hardcoded secret in your pull request
GitGuardian id Secret Commit Filename
- Generic High Entropy Secret de5156e charts/stable/bazarr/ci/default-values.yaml View secret
🛠 Guidelines to remediate hardcoded secrets
  1. Understand the implications of revoking this secret by investigating where it is used in your code.
  2. Replace and store your secret safely. Learn here the best practices.
  3. Revoke and rotate this secret.
  4. If possible, rewrite git history. Rewriting git history is not a trivial act. You might completely break other contributing developers' workflow and you risk accidentally deleting legitimate data.

To avoid such incidents in the future consider


🦉 GitGuardian detects secrets in your source code to help developers and security teams secure the modern development process. You are seeing this because you or someone else with access to this repository has authorized GitGuardian to scan your pull request.

Our GitHub checks need improvements? Share your feedbacks!

@RobReus RobReus changed the title WIP feat(bazarr) Adding exportarr to expose metrics to prometheus feat(bazarr) Adding exportarr to expose metrics to prometheus Nov 20, 2023
charts/stable/bazarr/values.yaml Outdated Show resolved Hide resolved
charts/stable/bazarr/values.yaml Outdated Show resolved Hide resolved
charts/stable/bazarr/questions.yaml Show resolved Hide resolved
charts/stable/bazarr/templates/common.yaml Outdated Show resolved Hide resolved
@PrivatePuffin PrivatePuffin marked this pull request as draft December 3, 2023 11:36
@PrivatePuffin PrivatePuffin marked this pull request as ready for review December 20, 2023 12:05
@PrivatePuffin PrivatePuffin enabled auto-merge (squash) December 20, 2023 12:05
@PrivatePuffin PrivatePuffin merged commit 417ba65 into truecharts:master Dec 20, 2023
15 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants