# Xygeni Sensor for Jenkins

The [Xygeni Sensor for Jenkins](https://github.com/jenkinsci/xygeni-sensor-plugin) monitors activity in the Jenkins Server where it is installed.

When the sensor detects an unusual activity, it will raise an alert for tracking the origin and taking immediate action to mitigate the risk and prevent further damage.

### How it works

The plugin extends event listeners to monitor user and process activity and performs periodic checks for changes in plugins. The collected data is sent in real time to Xygeni.

### Installation

#### Requirements: <a href="#requirements" id="requirements"></a>

* Java >= 11
* Jenkins >= 2.387.3

#### 1. Set up credentials

* In Jenkins, navigate to `Manage Jenkins > Manage Credentials > System > Global Credentials > Add Credentials`
  * Select `Secret text` as Kind and fill out required information

<figure><img src="https://4096647782-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FUTz59rJLkJBjiRWAMknU%2Fuploads%2Fa4htKLU8kCQkkARvvboQ%2Fimage.png?alt=media&#x26;token=23af2bfa-e001-4fc6-a6c9-233a284d3cbb" alt="" width="375"><figcaption></figcaption></figure>

#### 2. Configure Xygeni Sensor plugin settings <a href="#id-2_configure_xygeni_sensor_plugin_settings" id="id-2_configure_xygeni_sensor_plugin_settings"></a>

* In Jenkins, navigate to `Manage Jenkins > Configure System > Xygeni Sensor`,
  * Set the `Xygeni Token Credential ID` (generated above).
  * Set the `Xygeni API Url` ([https://api.xygeni.io](https://api.xygeni.io/)).
  * Optionally click the `TestToken` button to check url connection and token validity.
  * Click the `Save` button.

<figure><img src="https://4096647782-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FUTz59rJLkJBjiRWAMknU%2Fuploads%2F0wq2g2LCjF3FkVrrWAme%2Fimage.png?alt=media&#x26;token=1d96aac1-9d63-44ed-9a3f-3d04eafe1a55" alt="" width="375"><figcaption></figcaption></figure>

### Alerts Tracking <a href="#alerts_tracking" id="alerts_tracking"></a>

You can navigate to the dashboard to keep track of all the Unusual Activity detected at the moment, ordered by time of exposure from most recent to less recent. Open [Anomalous Activity Summary](https://docs.xygeni.io/xygeni-products/anomaly-detection/anomaly-detection-user-interface-guide).