You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: integration/Instructions.md
+39-98Lines changed: 39 additions & 98 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,77 +14,54 @@ To install the Chargeback integration, please follow these steps:
14
14
15
15
See [Requirements](README.md#requirements) for details.
16
16
17
-
### 2. Create Lookup Indices and Data View:
18
-
- Copy the Index creation commands (below) to Kibana Dev Tools.
19
-
- If required, modify the desired values for the `chargeback_conf_lookup` index. Note, these can be changed at a later stage.
20
-
- Change the `conf_*_weight` values to set the blended weight calculations, or use defaults.
21
-
- Change the `conf_ecu_rate` value so that the dashboard is in the desired rate, and `conf_ecu_rate_unit` to the unit representing the rate. For example a rate of `17.6` and unit of `ZAR` will show the cost in South African Rand, wherease a rate of `1` and unit of `USD` will show the cost in United States Dollar.
22
-
- Create the required `mode: lookup` indices by executing all of the commands.
23
-
- Create the required Kibana data view which is used in the Dashboard control.
- Upload the provided ZIP file by clicking on `upload it as a .zip`
53
25
54
-
# Add the default configuration to the chargeback_conf_lookup index with ID "config".
55
-
# This creates a document that can be updated later using _update/config.
56
-
POST chargeback_conf_lookup/_doc/config
57
-
{
58
-
"config_join_key": "chargeback_config",
59
-
"conf_ecu_rate": 0.85,
60
-
"conf_ecu_rate_unit": "EUR",
61
-
"conf_indexing_weight": 20,
62
-
"conf_query_weight": 20,
63
-
"conf_storage_weight": 40,
64
-
"conf_start_date": "2024-01-01T00:00:00.000Z",
65
-
"conf_end_date": "2024-12-31T23:59:59.999Z"
66
-
}
26
+
67
27
68
-
# Add additional configuration for a different time period (optional).
69
-
# This creates a new document with an auto-generated ID for time-based rate changes.
70
-
POST chargeback_conf_lookup/_doc
71
-
{
72
-
"config_join_key": "chargeback_config",
73
-
"conf_ecu_rate": 0.95,
74
-
"conf_ecu_rate_unit": "EUR",
75
-
"conf_indexing_weight": 20,
76
-
"conf_query_weight": 20,
77
-
"conf_storage_weight": 40,
78
-
"conf_start_date": "2025-01-01T00:00:00.000Z",
79
-
"conf_end_date": "2025-12-31T23:59:59.999Z"
80
-
}
81
-
```
28
+
### 3. Transforms Auto-Start
29
+
30
+
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.
31
+
32
+
**Starting from version 0.2.10**, the `chargeback_conf_lookup` index is automatically created via a bootstrap transform during installation. No manual setup is required! The transform creates the index with default configuration:
33
+
-**ECU rate:** 0.85 EUR
34
+
-**Weights:** indexing=20, query=20, storage=40
35
+
-**Date range:** 2010-01-01 to 2046-12-31
36
+
37
+
You can modify these values after installation if needed (see Configuration section below).
38
+
39
+
**Performance Note:** On clusters with months of historical monitoring data for multiple deployments, the initial transform execution may process a large volume of data. This can cause temporary performance impact during the first run. The transforms will then run incrementally on their configured schedules (15-60 minute intervals), processing only new data with minimal overhead.
40
+
41
+
### 4. Configure Alerting Rules (Optional)
42
+
43
+
Version 0.2.8 includes three pre-configured alerting rule templates:
44
+
-**Transform Health Monitoring** - Monitors transform health status
45
+
-**New Chargeback Group Detection** - Alerts on new chargeback group tags
46
+
-**Missing Usage Data** - Detects deployments with missing usage data
82
47
83
-
</details>
48
+
These rules can be configured in **Stack Management → Rules** after installation.
49
+
50
+
**Important:** For the New Chargeback Group Detection and Missing Usage Data alert rules, ensure that the Chargeback transforms are running before setting them up. These alerting rules query the lookup indices created by the transforms. If the transforms are not started, the alerts will not function correctly.
51
+
52
+
## Upgrade integration
53
+
54
+
To upgrade the integration, do the following:
55
+
- Upload the new asset (ZIP) file to Kibana.
56
+
- Transforms will auto-start (from version 0.2.8 onwards).
57
+
58
+
**Upgrading from 0.2.9 to 0.2.10:**
59
+
- No manual steps required for the `chargeback_conf_lookup` index - the bootstrap transform will automatically create it if it doesn't exist.
60
+
- If you previously manually created the `chargeback_conf_lookup` index, it will continue to work with the new version.
84
61
85
62
## Configuration
86
63
87
-
Configuration values are stored in the `chargeback_conf_lookup` index. The dashboard automatically applies the correct configuration based on the billing date falling within the `conf_start_date` and `conf_end_date` range.
64
+
Configuration values are stored in the `chargeback_conf_lookup` index, which is automatically created by version 0.2.10. The dashboard automatically applies the correct configuration based on the billing date falling within the `conf_start_date` and `conf_end_date` range.
88
65
89
66
### Update the default configuration:
90
67
@@ -122,39 +99,3 @@ POST chargeback_conf_lookup/_doc
- Browse to Integrations, and click on `+ Create new integration`
131
-
132
-
133
-
134
-
- Upload the provided ZIP file by clicking on `upload it as a .zip`
135
-
136
-
137
-
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
-
**Performance Note:** On clusters with months of historical monitoring data for multiple deployments, the initial transform execution may process a large volume of data. This can cause temporary performance impact during the first run. The transforms will then run incrementally on their configured schedules (15-60 minute intervals), processing only new data with minimal overhead.
143
-
144
-
### 5. Configure Alerting Rules (Optional)
145
-
146
-
Version 0.2.8 includes three pre-configured alerting rule templates:
147
-
-**Transform Health Monitoring** - Monitors transform health status
148
-
-**New Chargeback Group Detection** - Alerts on new chargeback group tags
149
-
-**Missing Usage Data** - Detects deployments with missing usage data
150
-
151
-
These rules can be configured in **Stack Management → Rules** after installation.
152
-
153
-
**Important:** For the New Chargeback Group Detection and Missing Usage Data alert rules, ensure that the Chargeback transforms are running before setting them up. These alerting rules query the lookup indices created by the transforms. If the transforms are not started, the alerts will not function correctly.
154
-
155
-
## Upgrade integration
156
-
157
-
To upgrade the integration, do the following:
158
-
- Depending on the change in version, you might need to delete the `*_lookup` indices, and create them again.
159
-
- Upload the new asset (ZIP) file to Kibana.
160
-
- For versions prior to 0.2.8, start the transforms manually. From 0.2.8 onwards, transforms auto-start.
Copy file name to clipboardExpand all lines: integration/README.md
+17-3Lines changed: 17 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,7 @@
2
2
3
3
## Version
4
4
5
-
Chargeback integration: 0.2.9
5
+
Chargeback integration: 0.2.10
6
6
7
7
## Dependencies
8
8
@@ -47,7 +47,7 @@ The first layer of processing that we do, is five transforms:
47
47
48
48
49
49
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.
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.**Version 0.2.10 introduces automated creation of the `chargeback_conf_lookup` index via a bootstrap transform**, eliminating the need for manual index creation.
51
51
52
52
**Performance Note:** On clusters with months of historical monitoring data for multiple deployments, the initial transform execution may process a large volume of data. This can cause temporary performance impact during the first run. The transforms will then run incrementally on their configured schedules (15-60 minute intervals), processing only new data with minimal overhead.
53
53
@@ -81,4 +81,18 @@ Version 0.2.8 includes three pre-configured Kibana alerting rule templates to he
81
81
82
82
These alerting templates are automatically installed with the integration and can be configured through **Stack Management → Rules** in Kibana.
83
83
84
-
**Important:** For alert rules 2 and 3, ensure that the Chargeback transforms are running before setting them up. These alerting rules query the lookup indices created by the transforms (`billing_cluster_cost_lookup`, `cluster_deployment_contribution_lookup`, etc.). If the transforms are not started, the alerts will not function correctly.
84
+
**Important:** For alert rules 2 and 3, ensure that the Chargeback transforms are running before setting them up. These alerting rules query the lookup indices created by the transforms (`billing_cluster_cost_lookup`, `cluster_deployment_contribution_lookup`, etc.). If the transforms are not started, the alerts will not function correctly.
85
+
86
+
## Version 0.2.10 Release Notes
87
+
88
+
### Bug Fixes
89
+
-**Visualization Display Issues:** Fixed visualizations not loading correctly due to integer division returning zero in ES|QL queries. All calculations now use TO_DOUBLE type conversion to prevent this issue.
90
+
91
+
### Enhancements
92
+
-**Automated Configuration Index:** The `chargeback_conf_lookup` index is now automatically created via a bootstrap transform during installation. This eliminates the need for manual index creation steps.
0 commit comments