Skip to content

Commit 3b0799a

Browse files
committed
Add version 0.2.8 with alerting rule templates and auto-start transforms
- Add three Kibana alerting rule templates: * Transform Health Monitoring * New Chargeback Group Detection * Missing Usage Data - Enable auto-start for all transforms (eliminates manual startup) - Update documentation to reflect auto-start behavior - Add Alerting Rules section to README - Update Instructions with alerting configuration steps Related to elastic/integrations#16229
1 parent e82f836 commit 3b0799a

File tree

4 files changed

+82
-6
lines changed

4 files changed

+82
-6
lines changed

integration/Instructions.md

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ PUT chargeback_conf_lookup
3636
"mappings": {
3737
"_meta": {
3838
"managed": true,
39-
"package": { "name": "chargeback", "version": "0.2.7" }
39+
"package": { "name": "chargeback", "version": "0.2.8" }
4040
},
4141
"properties": {
4242
"config_join_key": { "type": "keyword" },
@@ -126,7 +126,7 @@ POST chargeback_conf_lookup/_doc
126126

127127
### 3. Upload ZIP File:
128128

129-
- Asset: [`chargeback-0.2.7.zip`](assets/0.2.7/chargeback-0.2.7.zip)
129+
- Asset: [`chargeback-0.2.8.zip`](assets/0.2.8/chargeback-0.2.8.zip)
130130
- Browse to Integrations, and click on `+ Create new integration`
131131

132132
![alt text](assets/img/CreateNewIntegration.png)
@@ -135,10 +135,22 @@ POST chargeback_conf_lookup/_doc
135135

136136
![alt text](assets/img/UploadItAsAZip.png)
137137

138+
### 4. Transforms Auto-Start
139+
140+
Starting from version 0.2.8, all Chargeback transforms are configured to auto-start upon installation. You no longer need to manually start the transforms.
141+
142+
### 5. Configure Alerting Rules (Optional)
143+
144+
Version 0.2.8 includes three pre-configured alerting rule templates:
145+
- **Transform Health Monitoring** - Monitors transform health status
146+
- **New Chargeback Group Detection** - Alerts on new chargeback group tags
147+
- **Missing Usage Data** - Detects deployments with missing usage data
148+
149+
These rules can be configured in **Stack Management → Rules** after installation.
138150

139151
## Upgrade integration
140152

141153
To upgrade the integration, do the following:
142154
- Depending on the change in version, you might need to delete the `*_lookup` indices, and create them again.
143155
- Upload the new asset (ZIP) file to Kibana.
144-
- Start the transforms.
156+
- For versions prior to 0.2.8, start the transforms manually. From 0.2.8 onwards, transforms auto-start.

integration/README.md

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## Version
44

5-
Chargeback integration: 0.2.7
5+
Chargeback integration: 0.2.8
66

77
## Dependencies
88

@@ -47,7 +47,7 @@ The first layer of processing that we do, is five transforms:
4747

4848
![Transforms](assets/img/Transforms.png)
4949

50-
All of the transforms create their own lookup index. There is also a lookup index for the configuration. The usage transforms need to be started manually.
50+
All of the transforms create their own lookup index. There is also a lookup index for the configuration. Starting from version 0.2.8, all transforms are configured to auto-start upon installation.
5151

5252
![Lookup Indices](assets/img/LookupIndices.png)
5353

@@ -67,4 +67,14 @@ Once you have uploaded the integration, you can navigate to the `[Chargeback] Co
6767

6868
## Sample dashboard
6969

70-
![Chargeback](<assets/img/[Chargeback] Cost and Consumption breakdown.png>)
70+
![Chargeback](<assets/img/[Chargeback] Cost and Consumption breakdown.png>)
71+
72+
## Alerting Rules
73+
74+
Version 0.2.8 includes three pre-configured Kibana alerting rule templates to help monitor your Chargeback integration:
75+
76+
1. **Transform Health Monitoring** - Monitors the health status of all Chargeback transforms and alerts when issues are detected
77+
2. **New Chargeback Group Detection** - Notifies when a new `chargeback_group` tag is added to a deployment
78+
3. **Missing Usage Data** - Alerts when a deployment with a chargeback group assigned is not sending usage/consumption data
79+
80+
These alerting templates are automatically installed with the integration and can be configured through **Stack Management → Rules** in Kibana.
1.26 MB
Binary file not shown.
Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
# Create the config lookup index for chargeback configuration.
2+
# This index will store configuration settings. Multiple documents can be added for different time periods.
3+
4+
PUT chargeback_conf_lookup
5+
{
6+
"settings": {
7+
"index.mode": "lookup",
8+
"index.hidden": true
9+
},
10+
"mappings": {
11+
"_meta": {
12+
"managed": true,
13+
"package": { "name": "chargeback", "version": "0.2.8" }
14+
},
15+
"properties": {
16+
"config_join_key": { "type": "keyword" },
17+
"conf_ecu_rate": { "type": "float" },
18+
"conf_ecu_rate_unit": { "type": "keyword"},
19+
"conf_indexing_weight": { "type": "integer" },
20+
"conf_query_weight": { "type": "integer" },
21+
"conf_storage_weight": { "type": "integer" },
22+
"conf_start_date": {"type": "date"},
23+
"conf_end_date": {"type": "date"}
24+
}
25+
}
26+
}
27+
28+
# Add the default configuration to the chargeback_conf_lookup index with ID "config".
29+
# This creates a document that can be updated later using _update/config.
30+
POST chargeback_conf_lookup/_doc/config
31+
{
32+
"config_join_key": "chargeback_config",
33+
"conf_ecu_rate": 0.85,
34+
"conf_ecu_rate_unit": "EUR",
35+
"conf_indexing_weight": 20,
36+
"conf_query_weight": 20,
37+
"conf_storage_weight": 40,
38+
"conf_start_date": "2024-01-01T00:00:00.000Z",
39+
"conf_end_date": "2024-12-31T23:59:59.999Z"
40+
}
41+
42+
# Add additional configuration for a different time period (optional).
43+
# This creates a new document with an auto-generated ID for time-based rate changes.
44+
POST chargeback_conf_lookup/_doc
45+
{
46+
"config_join_key": "chargeback_config",
47+
"conf_ecu_rate": 0.95,
48+
"conf_ecu_rate_unit": "EUR",
49+
"conf_indexing_weight": 20,
50+
"conf_query_weight": 20,
51+
"conf_storage_weight": 40,
52+
"conf_start_date": "2025-01-01T00:00:00.000Z",
53+
"conf_end_date": "2025-12-31T23:59:59.999Z"
54+
}

0 commit comments

Comments
 (0)