https://github.com/inspector-apm/inspector-spring-demo

Spring application monitored by Inspector
https://github.com/inspector-apm/inspector-spring-demo

Last synced: about 6 hours ago
JSON representation

Spring application monitored by Inspector

• Host: GitHub
• URL: https://github.com/inspector-apm/inspector-spring-demo
• Owner: inspector-apm
• Created: 2024-01-08T16:02:27.000Z (10 months ago)
• Default Branch: master
• Last Pushed: 2024-08-22T15:16:19.000Z (3 months ago)
• Last Synced: 2024-09-14T04:16:11.483Z (about 2 months ago)
• Language: Java
• Size: 77.1 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Spring Agent Setup

## How to install spring agent in a demo project

### 1. Add the following dependency to the pom.xml file

``` 

    dev.inspector

	springagent

	1.0.0

```

### 2. Reload the maven dependencies

```

mvn clean install

```

### 3. Add the following configuration to the application.properties file

```

inspector.ingestion-key=81e6d4df93e1bfad8e9f3c062022e3a0d8a77dce

```

### 4. Start the application

Using the IDE to start the application

# Inspector Configuration Guide

This guide provides an overview of the necessary environment variables you need to set in your YAML configuration file to properly configure and use Inspector in your application.

## Environment Variables

To fully integrate Inspector, you need to set the following environment variables in your YAML file:

1. **INSPECTOR_INGESTION_KEY** - Your unique ingestion key for authenticating API requests.

    - Example: `INSPECTOR_INGESTION_KEY="your_ingestion_key_here"`

2. **INSPECTOR_ENABLE** - Determines whether Inspector is enabled or disabled.

    - Values: `true` or `false`

    - Example: `INSPECTOR_ENABLE=true`

3 **INSPECTOR_MAX_ITEMS** - Defines the maximum number of items Inspector should handle per session.

    - Example: `INSPECTOR_MAX_ITEMS=1000`

## Configuration Example

Here is a sample snippet from a YAML configuration file integrating these environment variables:

```yaml

environment:

  INSPECTOR_INGESTION_KEY: "your_ingestion_key_here"

  INSPECTOR_ENABLE: true

  INSPECTOR_MAX_ITEMS: 1000