maplelabs / maplelabs/FOSS-Projects

Jenkins monitoring plugins

Open
#3 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

proposal
Dominant language
No language data
Stars
1
Forks
1
PR merge metrics
No merged PRs in 30d

Description

# Proposal description:

Jenkins monitoring plugins will provide ability to monitor the Jenkins operations. It will give high-level overview of how the jobs are performing, the current status of all jobs that have run in the past days.

The plugin will be built using a generic frame so other plugins can be created using the same framework. The plugin should be able to send metrics to different target namely kafka, elasticsearch, opensearch. The plugin uses Jenkins API to retrieve all information,

This can be readily consumed by Snappyflow and Telegraf. This plugin does not require a plugin on Jenkins and it makes use of Jenkins API to retrieve all the information needed.

## Key pain points or opportunity details

• Datadog, New relic has plugin to monitor jenkins but they are all plugin on Jenkins.
• Our plugin provides an overview of Jenkins jobs which usually takes much longer time for checking the status by logging into Jenkins portal.

## Objective of the proposed project
Following are the deliverables for the proposed project:

- Generic framework to create new plugins.
- Jenkins monitoring plugin that collects below metrics.

• Total number of Jenkins jobs that has run in the past, jobs being currently executing, and jobs created but not build.
• Total number of nodes/Active nodes in Jenkins.
• Time completion of successful builds.
• Total number of queued jobs.
• Artifacts generated by jobs.

## Existing alternatives & why I think they are not enough (with links to those projects)

• We have existing alternative solution present like Monitoring Jenkins with Datadog, Newrelic and monitoring with Prometheus and Grafana. (https://www.jenkins.io/doc/book/system-administration/monitoring/). These plugins are jenkins integrate plugins. Cannot be used to send data to targets other than datadog/grafana.

## Ballpark effort estimate (X engineers for Y Months)
• 1 Engineers for 2 months.

## Expected number of users/organizations of the proposed project (Submit supporting material, if it exists).

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

The issue names no repository files, tests, or entry points. Start by reviewing the proposed Jenkins API data and the generic framework requirements, then define how metrics reach Kafka, Elasticsearch, and OpenSearch. Done means the framework and monitoring plugin collect the listed job, node, build, queue, and artifact metrics.

Written by the indexing model from the issue text.

Assessment

Tech stack
elasticsearch, kafka
Domain
devops, observability-sre
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
18/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.