{"id":14984723,"url":"https://github.com/jenkinsci/argus-notifier-plugin","last_synced_at":"2025-10-19T11:31:48.349Z","repository":{"id":25094120,"uuid":"102878502","full_name":"jenkinsci/argus-notifier-plugin","owner":"jenkinsci","description":"sends build status and time to an Argus endpoint","archived":false,"fork":false,"pushed_at":"2023-01-20T23:01:16.000Z","size":191,"stargazers_count":1,"open_issues_count":11,"forks_count":5,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-01-29T14:39:12.696Z","etag":null,"topics":["adopt-this-plugin","argus","build-status","build-time","jenkins","jenkins-ci","jenkins-plugin","metrics","time-series"],"latest_commit_sha":null,"homepage":"https://plugins.jenkins.io/argus-notifier/","language":"Java","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jenkinsci.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-09-08T15:51:39.000Z","updated_at":"2023-10-17T20:53:28.000Z","dependencies_parsed_at":"2023-02-12T06:30:42.785Z","dependency_job_id":null,"html_url":"https://github.com/jenkinsci/argus-notifier-plugin","commit_stats":null,"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jenkinsci%2Fargus-notifier-plugin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jenkinsci%2Fargus-notifier-plugin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jenkinsci%2Fargus-notifier-plugin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jenkinsci%2Fargus-notifier-plugin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jenkinsci","download_url":"https://codeload.github.com/jenkinsci/argus-notifier-plugin/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":237117166,"owners_count":19258364,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["adopt-this-plugin","argus","build-status","build-time","jenkins","jenkins-ci","jenkins-plugin","metrics","time-series"],"created_at":"2024-09-24T14:09:34.326Z","updated_at":"2025-10-19T11:31:48.021Z","avatar_url":"https://github.com/jenkinsci.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Argus Notifier\n**NOTE: This plugin is no longer maintained and is up for adoption. Be aware that there may be vulnerable dependencies as a result.**\n\n[![License](https://img.shields.io/github/license/jenkinsci/argus-notifier.svg)](LICENSE)\n[![Jenkins Plugin](https://img.shields.io/jenkins/plugin/v/argus-notifier.svg)](https://plugins.jenkins.io/argus-notifier)\n[![GitHub release](https://img.shields.io/github/release/jenkinsci/argus-notifier-plugin.svg?label=changelog)](https://github.com/jenkinsci/argus-notifier-plugin/releases/latest)\n[![Jenkins Plugin Installs](https://img.shields.io/jenkins/plugin/i/argus-notifier.svg?color=blue)](https://plugins.jenkins.io/argus-notifier)\n\nThis Jenkins plugin sends build status and build time (including queue time, build time, and total time) to \nan [Argus](https://github.com/salesforce/Argus) endpoint. It also sends system metrics from the \n[Metrics](https://plugins.jenkins.io/metrics) plugin. Administrators can configure whether system and build metrics\nare automatically sent or not.\n\n### Table of Contents\n* [Demo](#demo)\n  * [Configuration](#configuration)\n  * [Show me the money!](#show-me-the-money)\n    * [Queue Information](#queue-information)\n    * [Executor Information](#executor-information)\n    * [Build Times and Statuses](#build-times-and-statuses)\n    * [System Information](#system-information)\n    * [Alerts](#alerts)\n* [Metric implementation details](#metric-implementation-details)\n* [Plugin Dependencies](#plugin-dependencies)\n* [Developer Stuff](#developer-stuff)\n  * [Build](#build)\n  * [Test](#test)\n  * [Releasing](#releasing)\n    \n## Demo\nSo, you're using, or considering, the [Argus](https://github.com/salesforce/Argus) \ntime-series monitoring and alerting platform and you also use Jenkins. Well, hey, \nyou should check this plugin out to easily send Jenkins metrics to [Argus](https://github.com/salesforce/Argus).\n\n### Configuration\nFirst, you'll need to have a valid `Username with Password` credential set up in your Jenkins \ncredentials. Next, you simply go to `Jenkins -\u003e Manage Jenkins -\u003e Configure System` and find the \nconfiguration for `Argus Notifier`. Then you'll configure the following values:\n\n* `Credentials Id` - A `Username with Password` credential that has access to your \n[Argus](https://github.com/salesforce/Argus) instance.\n* `Argus URL` - The URL to your [Argus](https://github.com/salesforce/Argus) web service endpoint. \n* `Scope` - The [Argus](https://github.com/salesforce/Argus) scope you'd like to use (typically we use a URL or \nconceptual name)\n* `Source` - The [Argus](https://github.com/salesforce/Argus) source you'd like to use \n(the plugin will set this to `Scope` if you don't fill this in)\n* `Send for all builds?` - Whether you'd like all builds to send build metrics (timings and status) upon build \ncompletion \n* `Send system metrics?` - Whether you'd like the plugin to send system metrics every minute\n\nYou can test that your connection works by hitting the `Test Connection` button as long as\nyou've selected a valid `Credentials Id` and filled in your `Argus URL`. See below:\n\n![Argus Notifier configuration - Test Connection animation](https://s3-us-west-1.amazonaws.com/argus-notifier-plugin/connection-validation.gif)\n\nOnce you've saved or applied your Jenkins configuration, the plugin will go to work.\n\n### Show me the money!\nSo, let's say we have a few jobs set up on Jenkins and a couple of them run quite a bit:\n1. `concurrent-runner` runs every minute and sleeps for 90 seconds\n2. `sir-runs-alot` runs every 3 minutes, says \"yep\" and then sleeps for 70 seconds\n\nBehold, the Jenkins jobs:\n![Jenkins jobs](https://s3-us-west-1.amazonaws.com/argus-notifier-plugin/jenkins-jobs-in-queue.gif)\n\n#### Queue Information\nClearly we're going to have jobs queue up since we only have 2 executors (WHAT?! NO AGENTS!!). So, let's check out our queue metrics in Argus:\n#### Queue Visualization (w/ legend)\n![Queue visualization with legend](https://s3-us-west-1.amazonaws.com/argus-notifier-plugin/jenkins-queue-visualization-legend.gif) \n\n#### Queue Visualization (you can hover over the graph to see labels)\n![Queue visualization with hover](https://s3-us-west-1.amazonaws.com/argus-notifier-plugin/jenkins-queue-visualization-hover.gif) \n\n#### Executor Information\nLet's see how those executors are doing...\n\n![Executor visualization with legend](https://s3-us-west-1.amazonaws.com/argus-notifier-plugin/jenkins-executor-visualization-legend.gif) \n![Executor visualization with hover](https://s3-us-west-1.amazonaws.com/argus-notifier-plugin/jenkins-executor-visualization-hover.gif) \n\n#### Build Times and Statuses\nWhat about those build runs?\n\n![Build visualization with legend](https://s3-us-west-1.amazonaws.com/argus-notifier-plugin/jenkins-build-visualization-legend.gif) \n![Build visualization with hover](https://s3-us-west-1.amazonaws.com/argus-notifier-plugin/jenkins-build-visualization-hover.gif) \n\n#### System Information\n![System visualization with legend](https://s3-us-west-1.amazonaws.com/argus-notifier-plugin/jenkins-system-visualization-legend.gif) \n![System visualization with hover](https://s3-us-west-1.amazonaws.com/argus-notifier-plugin/jenkins-system-visualization-hover.gif) \n![System animation](https://s3-us-west-1.amazonaws.com/argus-notifier-plugin/jenkins-system-visualization.gif) \n\n#### Alerts\nOf course, since [Argus](https://github.com/salesforce/Argus) is also an alerting platform you could set alerts for any of these metrics. :smile:\n\n## Metric implementation details \n* Timings are currently sent in units of seconds for consistency\n* `Result` statuses are mapped to numbers in \n[BuildResultsResolver](https://github.com/justinharringa/argus-notifier/blob/master/src/main/java/org/jenkinsci/plugins/argusnotifier/BuildResultsResolver.java#L22)\n* Numeric gauge metrics from the [Metrics](https://plugins.jenkins.io/metrics) plugin are sent if configured.\n \n\n## Plugin Dependencies\n* [Metrics](https://plugins.jenkins.io/metrics) - used to get the queue time\n* [Credentials](https://plugins.jenkins.io/credentials) - securely store your [Argus](https://github.com/salesforce/Argus)\ncredentials \n\n## Developer Stuff\n\n### Build\nTo build the project with [Maven](https://maven.apache.org/), simply run `mvn clean package`\n\n### Test\nRun `mvn clean hpi:run` to start up a test version of Jenkins with the requisite plugins installed.\n\n### Releasing\nRun `mvn release:prepare release:perform` but ensure that your Maven `settings.xml` has been \n[set up with your Artifactory password](https://wiki.jenkins.io/display/JENKINS/Hosting+Plugins#HostingPlugins-Releasingtojenkins-ci.org)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjenkinsci%2Fargus-notifier-plugin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjenkinsci%2Fargus-notifier-plugin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjenkinsci%2Fargus-notifier-plugin/lists"}