[Dashboard] cert-manager

grandwizard28 commented 2 months ago

Dashboard Name

Cert-Manager Monitoring Dashboard

Expected Dashboard Sections and Panels

(Can be tweaked (add or remove panels/sections) according to available metrics)

General Overview

This section provides a high-level overview of the cert-manager's health and performance metrics, allowing for a quick assessment of the system's current state.

Panels

Total Certificates Issued
- Description: Displays the total number of certificates successfully issued by cert-manager.
Active Certificates
- Description: Shows the current number of active certificates managed by cert-manager.
Certificate Requests
- Description: Illustrates the number of certificate requests processed, including pending and completed requests.
Uptime
- Description: Displays the total uptime of the cert-manager since the last restart.

Certificate Issuance

This section focuses on the metrics related to the issuance of certificates, helping monitor the creation and provisioning of TLS certificates.

Panels

Certificates Issued per Issuer
- Description: Shows the number of certificates issued by each configured issuer (e.g., Let's Encrypt, HashiCorp Vault).
Issuance Rate
- Description: Displays the rate at which certificates are being issued over time, measured per minute/hour.
Issuance Success Rate
- Description: Illustrates the percentage of successful certificate issuances versus failed attempts.

Certificate Renewal

This section provides insights into the certificate renewal process, ensuring that certificates are renewed in a timely manner to maintain security.

Panels

Certificates Pending Renewal
- Description: Shows the number of certificates that are approaching their expiration date and are pending renewal.
Renewal Success Rate
- Description: Displays the percentage of successful renewals versus failed renewal attempts.
Renewal Duration
- Description: Illustrates the average time taken to renew certificates, highlighting any delays in the process.

Error Metrics

This section monitors errors and failures within cert-manager operations, aiding in the troubleshooting and resolution of issues.

Panels

Certificate Issuance Errors
- Description: Displays the number of errors encountered during the certificate issuance process.
Renewal Errors
- Description: Shows the number of errors that occurred during the certificate renewal process.
API Server Errors
- Description: Monitors errors related to communication with the Kubernetes API server, affecting cert-manager's functionality.

Resource Usage

This section provides insights into the resource consumption of the cert-manager, helping ensure it operates efficiently within the Kubernetes cluster.

Panels

CPU Usage
- Description: Displays the CPU usage by the cert-manager pods, indicating the processing load.
Memory Usage
- Description: Shows the memory consumption of the cert-manager, helping identify potential memory leaks or inefficiencies.
Pod Restarts
- Description: Monitors the number of times cert-manager pods have restarted, which could indicate stability issues.

API and Event Metrics

This section tracks API requests and events handled by cert-manager, providing visibility into its interactions within the Kubernetes ecosystem.

Panels

API Request Rate
- Description: Displays the rate of API requests processed by cert-manager over time.
Event Processing Rate
- Description: Shows the number of Kubernetes events processed by cert-manager, indicating its responsiveness to cluster changes.
Failed API Requests
- Description: Monitors the number of failed API requests, aiding in identifying communication issues with the Kubernetes API server.

Expected Dashboard Variables

namespace – Filter metrics based on the Kubernetes namespace where cert-manager is deployed.
issuer – Select specific certificate issuers (e.g., Let's Encrypt, HashiCorp Vault) to filter metrics.
certificate_name – Filter metrics based on specific certificate names.
cluster – For multi-cluster setups, filter metrics based on the Kubernetes cluster.
deployment.environment

References or Screenshots

Please review the CONTRIBUTING.md for guidelines on dashboard structure, naming conventions, and how to submit a pull request.

makeavish commented 1 month ago

/bounty 250

algora-pbc[bot] commented 1 month ago

💎 $250 bounty • SigNoz

Steps to solve:

Start working: Comment /attempt #6023 with your implementation plan
Submit work: Create a pull request including /claim #6023 in the PR body to claim the bounty
Receive payment: 100% of the bounty is received 2-5 days post-reward. Make sure you are eligible for payouts

Thank you for contributing to SigNoz/signoz!

Add a bounty • Share on socials

Attempt	Started (GMT+0)	Solution
🟢 @KshitijBhardwaj18	Oct 23, 2024, 2:46:05 PM	WIP
🟢 @Temidayo32	Oct 27, 2024, 8:37:32 PM	#105
🟢 @nishchay-veer	Oct 28, 2024, 7:02:39 PM	WIP
🟢 @tdabasinskas	Oct 30, 2024, 7:31:07 PM	WIP