Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 25 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -109,10 +109,20 @@ Version 1.0.0 - Production Ready

After installation, follow these steps to initialize CACA:

### 1. Verify Index Creation
### 1. Create the Metrics Index

The `caca_metrics` index should be created automatically. Verify by running:
Create a metrics index named `caca_metrics` before using CACA:

**For Splunk Enterprise:**
```spl
| rest /services/data/indexes | search title=caca_metrics
```
If the index doesn't exist, create it via CLI or indexes.conf (see Configuration section).

**For Splunk Cloud:**
Request your Splunk Cloud administrator to create a metrics index named `caca_metrics`.

Verify the index exists:
```spl
| eventcount summarize=false index=caca_metrics
```
Expand Down Expand Up @@ -397,15 +407,24 @@ Edit `default/savedsearches.conf` or use Splunk Web to modify:
- **Health tracking frequency**: Default every 15 minutes
- **Registry update frequency**: Default daily at 2 AM

### Customizing Metrics Retention
### Creating the Metrics Index

CACA requires a metrics index named `caca_metrics`. This index must be created manually before using the app.

Edit `default/indexes.conf` to adjust retention:
**For Splunk Enterprise:**
```bash
# Via CLI
splunk add index caca_metrics -datatype metric

```ini
# Or add to $SPLUNK_HOME/etc/system/local/indexes.conf:
[caca_metrics]
frozenTimePeriodInSecs = 31536000 # 1 year (default)
datatype = metric
frozenTimePeriodInSecs = 31536000
```

**For Splunk Cloud:**
Contact your Splunk Cloud administrator to create a metrics index named `caca_metrics` with appropriate retention settings.

### Configurable Thresholds

CACA uses configurable thresholds stored in `lookups/caca_settings.csv`. You can customize these settings to match your environment:
Expand Down
12 changes: 0 additions & 12 deletions default/indexes.conf

This file was deleted.

Loading