Skip to content

Commit f3da033

Browse files
sumoanemaamee-sumo
andauthored
Updating the doc with compatible jenkins version to use the sumologic… (#5814)
* Updating the doc with compatible jenkins version to use the sumologic jenkins plugin * Updating the doc with jenkins version and java version with which last plugin release was tested. * Update jenkins.md --------- Co-authored-by: Amee Lepcha <[email protected]>
1 parent 296b11a commit f3da033

File tree

1 file changed

+43
-45
lines changed

1 file changed

+43
-45
lines changed

docs/integrations/app-development/jenkins.md

Lines changed: 43 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -11,20 +11,19 @@ import useBaseUrl from '@docusaurus/useBaseUrl';
1111

1212
[Jenkins](https://jenkins.io/) is an open source automation server that provides a simple way to set up a continuous integration or delivery environment for building and testing software. The Sumo Logic App for Jenkins helps you monitor your build processes and Jenkins master and server health via pre-configured dashboards.
1313

14-
The Jenkins App allows you to monitor multiple Jenkins master nodes from a single-pane of glass. The app supports freestyle and pipeline jobs as well as pipeline, maven and multi-branch pipeline projects.
15-
16-
Sumo Logic Jenkins plugin is compatible with Jenkins version 2.361.1. For more information refer [Sumo Logic Jenkins Plugin WIKI](https://plugins.jenkins.io/sumologic-publisher) page.
14+
The Jenkins App allows you to monitor multiple Jenkins master nodes from a single pane of glass. The app supports freestyle and pipeline jobs as well as pipeline, Maven, and multi-branch pipeline projects.
15+
The Sumo Logic Jenkins plugin is compatible with Jenkins version 2.426.3 and above. For more information, refer to the [Sumo Logic Jenkins Plugin WIKI](https://plugins.jenkins.io/sumologic-publisher) page.
1716

1817
## Log and metric types
1918

20-
All logs are JSON based, with the exception of job console logs. Graphite format metrics are generated.
19+
All logs are JSON-based, with the exception of job console logs. Graphite format metrics are generated.
2120

2221
The Jenkins app uses the following log types:
23-
* **Audit Logs**. Log events related to user authentication, Jenkins system and job configuration changes and Jenkins job run events.
24-
* **Metric Data**. Log events related to metric information of Jenkins Master.
25-
* **Periodic Logs**. Log events related to Jenkins nodes, master shutdown events, jobs in progress and in queue.
26-
* **SCM Log**. Log events related to Source Control Management systems like the github repository.
27-
* **Job Status Logs**. Log events related to Jenkins jobs, test results and pipeline stages.
22+
* **Audit Logs**. Log events related to user authentication, Jenkins system, job configuration changes, and Jenkins job run events.
23+
* **Metric Data**. Log events related to the metric information of the Jenkins Master.
24+
* **Periodic Logs**. Log events related to Jenkins nodes, master shutdown events, jobs in progress, and in the queue.
25+
* **SCM Log**. Log events related to Source Control Management systems, like the GitHub repository.
26+
* **Job Status Logs**. Log events related to Jenkins jobs, test results, and pipeline stages.
2827
* **Job Console Logs**. Log events related to job console logs.
2928

3029
### Sample log messages
@@ -284,8 +283,7 @@ _sourceCategory=Labs/Jenkins/Sourabh/Logs In_Progress
284283
## Collecting logs and metrics for Jenkins
285284

286285
This section provides instructions for configuring log and metric collection for the Sumo Logic App for Jenkins.
287-
288-
Sumo Logic Jenkins plugin is compatible with Jenkins version 2.60.1 and above. For more information refer [Sumo Logic Jenkins Plugin WIKI](https://plugins.jenkins.io/sumologic-publisher) page.
286+
The Sumo Logic Jenkins plugin is compatible with Jenkins version 2.426.3 and above. For more information, refer to the [Sumo Logic Jenkins Plugin WIKI](https://plugins.jenkins.io/sumologic-publisher) page.
289287

290288

291289
### Step 1: Configure a Collector
@@ -296,16 +294,16 @@ To create a new Sumo Logic hosted collector, perform the steps in the [Configure
296294

297295
To create a new HTTP logs and metric source:
298296

299-
1. Create a new HTTP Logs and Metrics Source in the hosted collector created above by following [these instructions.](/docs/send-data/hosted-collectors/http-source/logs-metrics)
297+
1. Create a new HTTP Logs and Metrics Source in the hosted collector created above by following [these instructions](/docs/send-data/hosted-collectors/http-source/logs-metrics).
300298
2. Make a note of **HTTP Source URL** and **Source Category**, as you will need them later in the configuration process.
301299

302300
### Step 3: Install the Jenkins Plugin
303301

304302
You must have Admin privileges to perform any of the following installation procedures. This section walks you through the ways in which you can install the Jenkins plugin.
305303

306304
:::note
307-
Beginning with Jenkins 2.357 (released on June 28, 2022) and the forthcoming 2.361.1 LTS release, Jenkins requires Java 11 or newer. The latest Sumo Logic Jenkins plugin works with Jenkins versions greater than 2.261.1 and Java 11.
308-
To install the plugin with Java 8 and older version of Jenkins, use the old release [(2.2.1)](https://repo.jenkins-ci.org/artifactory/releases/org/jenkins-ci/plugins/sumologic-publisher/2.2.1/sumologic-publisher-2.2.1.hpi) of Sumo Logic plugin.
305+
Sumo Logic's latest Jenkins plugin is certified against Java 21 with Jenkins versions 2.516.2. It requires Jenkins to run on Java 11, 17, or 21 and a minimum Jenkins version of 2.426.3.
306+
To install the plugin with Java 8 and older versions of Jenkins, use the old release [(2.2.1)](https://repo.jenkins-ci.org/artifactory/releases/org/jenkins-ci/plugins/sumologic-publisher/2.2.1/sumologic-publisher-2.2.1.hpi) of the Sumo Logic plugin.
309307
:::
310308

311309
<details>
@@ -321,11 +319,11 @@ This section shows you how to update the version of the Jenkins plugin you have
321319
</details>
322320

323321
<details>
324-
<summary><strong>Installing with the sumologic publisher</strong>: use this method if you're using the sumologic publisher for the first time.</summary>
322+
<summary><strong>Installing with the Sumo Logic publisher</strong>: use this method if you're using the Sumo Logic publisher for the first time.</summary>
325323

326-
This section shows you how to install the Jenkins plugin, if this is your first time using sumologic publisher.
324+
This section shows you how to install the Jenkins plugin if this is your first time using Sumo Logic Publisher.
327325

328-
To perform a first time installation, do the following:
326+
To perform a first-time installation, do the following:
329327
1. In the Jenkins console, go to **Manage Jenkins** > **Manage Plugins**.
330328
1. Click the **Available** tab.
331329
1. Search for "**Sumologic Publisher**".
@@ -346,7 +344,7 @@ This section shows you how to manually install the Jenkins plugin.
346344
5. Select **Restart Jenkins when installation is complete and no jobs are running**. You may need to restart Jenkins for the plugin to appear.
347345

348346
:::note
349-
The plugin is available on Jenkins plugin center. Ignore the version mentioned in the Jenkins Plugin update center.
347+
The plugin is available on the Jenkins plugin center. Ignore the version mentioned in the Jenkins Plugin update center.
350348
:::
351349

352350
</details>
@@ -361,21 +359,21 @@ To configure the Jenkins Plugin, do the following:
361359
2. Search for the **Sumo Logic Jenkins** **Plugin**.
362360
3. In the Sumo Logic Jenkins Plugin dialog, specify the following:
363361
* **SumoLogic Portal Name** - This is the domain name of the hosted collector. For example, `service.sumologic.com` or `service.us2.sumologic.com`.
364-
* **Metric Data Prefix**: Enter the name of the Jenkins Master on which plugin is installed.
362+
* **Metric Data Prefix**: Enter the name of the Jenkins Master on which the plugin is installed.
365363
* **HTTP Source URL**: HTTP Source URL from step 2. The HTTP source URL will look something like this: `https://sumologic_url/receiver/v1/http/SECRET_STRING`.
366364
* **Source Category**: This is the Source Category you defined for the source.
367-
* **Keep Old Configuration for Jobs**: Enable this option to send old configuration for jobs.
365+
* **Keep Old Configuration for Jobs**: Enable this option to send the old configuration for jobs.
368366
4. Specify the types of data you want to send to Sumo Logic:
369367
* **Metric Data** - Sends metric information.
370-
* **Audit Logs** - Sends audit information like login, logouts, login failures, configuration changes to jobs and the Jenkins servers.
371-
* **Periodic Logs** - Sends periodic information like node information, master information, shutdown events, Jenkins system logs.
368+
* **Audit Logs** - Sends audit information like login, logouts, login failures, configuration changes to jobs, and the Jenkins servers.
369+
* **Periodic Logs** - Sends periodic information like node information, master information, shutdown events, and Jenkins system logs.
372370
* **SCM logs** - Send Source Control Management logs related to builds.
373371
5. Specify the following:
374372
* **Job Status Information**: Select to send status for all jobs
375373
* **Console Logs Information**: Select to send console logs for all jobs
376-
6. Jenkins plugin can be configured with an HTTP proxy. Once this is configured all the logs which are being sent from the Jenkins plugin will go through the proxy before getting ingested in sumo logic. Following are the parameters which are introduced to support the same:
374+
6. The Jenkins plugin can be configured with an HTTP proxy. Once this is configured, all the logs that are being sent from the Jenkins plugin will go through the proxy before being ingested in Sumo Logic. The following are the parameters that are introduced to support the same:
377375
* **Enable Proxy Setting (checkbox):** Check to Enable proxy setting
378-
* **Proxy Host:** User to input the proxy server host-name here.
376+
* **Proxy Host:** User to input the proxy server hostname here.
379377
* **Proxy port:** Specify the port of the proxy server.
380378
* **Enable Proxy Authentication(checkbox):** Check to enable Authentication for the proxy. This can be used if the proxy is configured with authentication.
381379
* **Username:** Username to be used for the proxy Authentication.
@@ -385,20 +383,20 @@ To configure the Jenkins Plugin, do the following:
385383

386384
### Step 5: Optional - Advanced Configuration
387385

388-
This section provides instructions for configuring Sumo Logic Jenkins Plugin for specific projects using Jenkins **configuration as code**. For more information, see [configuration as code](https://jenkins.io/projects/jcasc/).
386+
This section provides instructions for configuring the Sumo Logic Jenkins Plugin for specific projects using Jenkins **configuration as code**. For more information, see [configuration as code](https://jenkins.io/projects/jcasc/).
389387

390-
To configure Sumo Logic Jenkins Plugin for specific projects using configuration as code, do the following:
388+
To configure the Sumo Logic Jenkins Plugin for specific projects using configuration as code, do the following:
391389

392390
1. The plugin can be configured using **configuration as code** provided by Jenkins as detailed [in this document](https://jenkins.io/projects/jcasc/).
393391
2. In case of specific jobs, do the following:
394392
* For freestyle and maven Projects, go to **Job Configuration** and in the Post-build Actions, select **Sumo Logic Build Logger.**
395393
* For Pipeline projects, do the following:
396-
1. In the pipeline configuration, for normal script make the following as the top level.
394+
1. In the pipeline configuration, for a normal script, make the following as the top level.
397395
```
398396
SumoPipelineLogCollection {
399397
// your script
400398
```
401-
2. Then, in the pipeline configuration, for declarative pipeline script update the option.
399+
2. Then, in the pipeline configuration, for the declarative pipeline script, update the option.
402400
```js
403401
options {
404402
SumoPipelineLogCollection()
@@ -426,24 +424,24 @@ The **Jenkins - Overview** dashboard shows relationships between jobs and execut
426424
Use this dashboard to:
427425
* Correlate job builds with Jenkins executors (worker nodes), physical memory utilization, disk space utilization, console logs, the number of executors used by jobs, and the number of unused (free) worker nodes.
428426
* Identify worker nodes not used by Jenkins master jobs to understand worker node usage.
429-
* Analyze job health by filtering data for a specific job to identify the console log errors, system errors, number of executors used, disk space utilization, physical memory utilization.
427+
* Analyze job health by filtering data for a specific job to identify the console log errors, system errors, number of executors used, disk space utilization, and physical memory utilization.
430428
* Identify Jenkins master shutdown events.
431-
* Analyze the jobs in the queue with job queue duration, reason, job URL.
429+
* Analyze the jobs in the queue with job queue duration, reason, and job URL.
432430
* Generate alerts based on shutdown events, job run duration, physical memory utilization, disk space utilization, and more.
433431
434432
<img src={useBaseUrl('img/integrations/app-development/Jenkins-Overview.png')} alt="jenkins" />
435433
436434
### System Monitoring
437435
438-
The **Jenkins - System Monitoring** dashboards provides information on system activities related to master node metrics, job metrics, worker nodes, and audit activities. System Monitoring dashboards help you to monitor changes related to the Jenkins configuration, job configuration, the health of the Jenkins master, performance of the job queue and run duration, as well as the health of all worker nodes available to the Jenkins master node.
436+
The **Jenkins - System Monitoring** dashboards provide information on system activities related to master node metrics, job metrics, worker nodes, and audit activities. System Monitoring dashboards help you to monitor changes related to the Jenkins configuration, job configuration, the health of the Jenkins master, performance of the job queue, and run duration, as well as the health of all worker nodes available to the Jenkins master node.
439437
440438
#### Audit
441439
442440
The **Jenkins - Audit** dashboard provides insight into user events, including configuration changes, authentication events, and job activities.
443441
444442
Use this dashboard to:
445443
446-
* Ensure only authorized users are accessing the Jenkins System and are modifying Jenkins system and job configurations.
444+
* Ensure only authorized users are accessing the Jenkins System and are modifying the Jenkins system and job configurations.
447445
* Keep track of the job configuration changes.
448446
* Compare old and new Jenkins system and job configuration settings.
449447
* View trends for Jenkins job start and finish events.
@@ -454,13 +452,13 @@ Use this dashboard to:
454452
455453
The **Jenkins - Master Health** dashboard provides insight into the health of Jenkins master nodes with information on shutdown events, Jenkins system logs, and metrics events such as CPU, memory, job duration, threads, and executors.
456454
457-
Executors are similar to threads that run jobs, so they are indicators of the load placed on Jenkins. If the executors are full, it means there are a lot of jobs running on the system and more executors may be needed to balance the load.
455+
Executors are similar to threads that run jobs, so they are indicators of the load placed on Jenkins. If the executors are full, it means there are a lot of jobs running on the system, and more executors may be needed to balance the load.
458456
459457
Use this dashboard to:
460458
* Monitor shutdown events for Jenkins master nodes.
461-
* Monitor Jenkins system sogs to determine the root cause of system issues.
459+
* Monitor Jenkins system logs to determine the root cause of system issues.
462460
* Monitor Jenkins master CPU usage and memory usage to allocate additional resources if needed.
463-
* Monitor free executors and busy executors on Jenkins master.
461+
* Monitor free executors and busy executors on the Jenkins master.
464462
465463
<img src={useBaseUrl('img/integrations/app-development/Jenkins-MasterHealth.png')} alt="jenkins" />
466464
@@ -470,7 +468,7 @@ The **Jenkins - Job Health** dashboard provides insight into the health of Jenki
470468
471469
Use this dashboard to:
472470
473-
* Monitor jobs in the queue, blocked and pending jobs to make sure your continuous integrations are running as expected.
471+
* Monitor jobs in the queue, blocked, and pending jobs to make sure your continuous integrations are running as expected.
474472
* Monitor garbage collection statistics on the Jenkins master to understand how to improve performance and allocate additional resources if necessary.
475473
476474
<img src={useBaseUrl('img/integrations/app-development/Jenkins-JobHealth.png')} alt="jenkins" />
@@ -500,7 +498,7 @@ Use this dashboard to:
500498
* Monitor job duration trends to understand how to improve the execution of various stages in the pipeline.
501499
* Monitor jobs in progress, and in queue to determine how the pipelines are performing and make adjustments to the build process if needed.
502500
* Identify the slowest failed builds.
503-
* View trends for job results and use that information to identify source code components and teams that need the most improvements.
501+
* View trends for job results and use that information to identify source code components and teams that need the most improvement.
504502
505503
<img src={useBaseUrl('img/integrations/app-development/Jenkins-JobOverview.png')} alt="jenkins" />
506504
@@ -509,8 +507,8 @@ Use this dashboard to:
509507
The **Jenkins - Job Information** dashboard provides detailed information about a specific job. Panels show information on job URLs, duration trends, execution results, test case trends, slowest stages for pipeline jobs, console logs, and common errors.
510508
511509
Use this dashboard to:
512-
* Monitor the total number of builds, successful builds, duration and failed builds for the job in question to understand how to best improve its execution going forward.
513-
* Drilldown to Jenkins build information as needed.
510+
* Monitor the total number of builds, successful builds, duration, and failed builds for the job in question to understand how to best improve its execution going forward.
511+
* Drill down to Jenkins build information as needed.
514512
* Investigate common errors using console logs.
515513
* Investigate common stage failures.
516514
* Monitor recent configuration changes and commits to identify potential causes of failure.
@@ -520,25 +518,25 @@ Use this dashboard to:
520518
521519
#### Build Information
522520
523-
The **Jenkins - Build Information** dashboard provides detailed information about a specific build. Panels show information on build parameters, source control management, commit details, test cases, pipeline stages, console logs, and configuration changes prior to a build.
521+
The **Jenkins - Build Information** dashboard provides detailed information about a specific build. Panels show information on build parameters, source control management, commit details, test cases, pipeline stages, console logs, and configuration changes before a build.
524522
525523
Use this dashboard to:
526524
* Monitor parameters used for the build and source control management, such as GitHub Repository, to understand recent commits that have been added to the build.
527525
* Investigate possible causes for build failure using configuration change before build details, test case failure, commit changes, pipeline stage failure, and console logs.
528-
* Investigate the cause for failed test cases by analyzing stack traces.
529-
* Investigate configuration changes before the build by comparing the old configuration and current configurations.
526+
* Investigate the cause of failed test cases by analyzing stack traces.
527+
* Investigate configuration changes before the build by comparing the old configuration and the current configuration.
530528
* Identify command failure for pipeline jobs using stage and stack trace information.
531529
532530
<img src={useBaseUrl('img/integrations/app-development/Jenkins-BuildInformation.png')} alt="jenkins" />
533531
534532
535533
#### Pipeline Stage Monitoring
536534
537-
The **Jenkins - Pipeline Stage Monitoring** dashboard provides insights into pipeline performances.
535+
The **Jenkins - Pipeline Stage Monitoring** dashboard provides insights into pipeline performance.
538536
539537
Use this dashboard to:
540538
* Identify which pipelines are taking the longest to complete.
541-
* Drilldown to slowest stages and steps within each pipeline.
539+
* Drill down to the slowest stages and steps within each pipeline.
542540
* Compare pipeline executions to identify which runs are slower or faster than others.
543541
* Identify the failed pipeline stages and steps.
544542
@@ -554,4 +552,4 @@ import AppUpdate from '../../reuse/apps/app-update.md';
554552
555553
import AppUninstall from '../../reuse/apps/app-uninstall.md';
556554
557-
<AppUninstall/>
555+
<AppUninstall/>

0 commit comments

Comments
 (0)