Skip to content

Commit 0b7aa86

Browse files
Renaming DWH - leftovers (#23558)
* Renamed everything that kind of made sense. Let's see if it still works. * Cleaning up; added changelog * Adding details about the data lake renaming --------- Co-authored-by: Maxwell <[email protected]>
1 parent 8cb5ad2 commit 0b7aa86

File tree

8 files changed

+129
-89
lines changed

8 files changed

+129
-89
lines changed

UPGRADING.md

Lines changed: 71 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -33,11 +33,44 @@ The logic for generating color shades based on custom-defined color variants (er
3333
has been slightly adjusted. This change ensures that the exact color specified in the customization settings
3434
is now used as the primary color for elements like buttons and badges in the UI.
3535

36+
### Renaming "Data Warehouse" to "Data Lake"
37+
The feature previously known as "Data Warehouse" is now completely renamed to "Data Lake". That includes not only text
38+
visible to the user, but with version 7.0 also a lot of places being usually invisible to the regular user, such as API
39+
endpoints, the content of the database, permissions and much more.
40+
41+
#### API Endpoints and permissions
42+
All endpoints related to data lake have changed their URLs accordingly. As also noted in
43+
the [REST API endpoint Changes](#rest-api-endpoint-changes), all endpoints previously accessible at
44+
`/api/plugins/org.graylog.plugins.datawarehouse/data_warehouse/...` are now moved to
45+
`/api/plugins/org.graylog.plugins.datalake/data_lake/...`. Similarly, all permissions regarding data lake are renamed
46+
from `data_warehouse...` to `data_lake...`.
47+
48+
#### Database content
49+
Three entire collections are renamed:
50+
- `data_warehouse_archive_config` to `data_lake_archive_config`
51+
- `data_warehouse_backends` to `data_lake_backends`
52+
- `data_warehouse_catalog` to `data_lake_catalog`
53+
54+
Also, documents of the following collections are updated to reflect the change in names:
55+
- `cluster_config` for migrations related to data lake
56+
- `enterprise_traffic`
57+
- `scheduler_job_definitions`
58+
- `scheduler_triggers`, in case a data lake optimization job is already scheduled.
59+
60+
#### Audit logs
61+
Audit logs having been written before the update are not changed. However, all audit logs from after the update contain
62+
the term "Data Lake" instead of "Data Warehouse".
63+
64+
#### Metrics
65+
Just like audit logs, metrics from before the update to version 7.0 are not changed. Starting with version 7.0, the
66+
names of data lake related metrics change accordingly.
67+
68+
3669
## Configuration File Changes
3770

38-
| Option | Action | Description |
39-
|---------------|------------|------------------------------------------------|
40-
| `tbd` | **added** | |
71+
| Option | Action | Description |
72+
|--------|-----------|-------------|
73+
| `tbd` | **added** | |
4174

4275
## Default Configuration Changes
4376

@@ -55,52 +88,54 @@ is now used as the primary color for elements like buttons and badges in the UI.
5588

5689
## General REST API Changes
5790

58-
- In Graylog 7.0, an issue was fixed that previously allowed additional unknown JSON properties to be accepted
59-
(and ignored) in API requests on the Graylog leader node. Now that the issue has been fixed, API requests on the
91+
- In Graylog 7.0, an issue was fixed that previously allowed additional unknown JSON properties to be accepted
92+
(and ignored) in API requests on the Graylog leader node. Now that the issue has been fixed, API requests on the
6093
leader node will once again only accept JSON payloads that contain explicitly mapped/supported properties.
61-
- APIs for entity creation now use a parameter `CreateEntityRequest` to keep entity fields separated from sharing
94+
- APIs for entity creation now use a parameter `CreateEntityRequest` to keep entity fields separated from sharing
6295
information. This is a breaking change for all API requests that create entities, such as streams, dashboards, etc.
63-
<br> Affected entities:
64-
- Search / Dashboard
65-
- Search Filter
66-
- Report
67-
- Event Definition
68-
- Stream
69-
- Notifications
70-
- Sigma rules
71-
- Event procedure
72-
- Event step
73-
- Content Pack installation
96+
<br> Affected entities:
97+
- Search / Dashboard
98+
- Search Filter
99+
- Report
100+
- Event Definition
101+
- Stream
102+
- Notifications
103+
- Sigma rules
104+
- Event procedure
105+
- Event step
106+
- Content Pack installation
74107
- Teams
75-
108+
76109
<br> For example, the request payload to create a stream might now look like this:
77110

78111
```json
79112
{
80-
"entity":{
81-
"index_set_id":"65b7ba138cdb8c534a953fef",
82-
"description":"An example stream",
83-
"title":"My Stream",
84-
"remove_matches_from_default_stream":false
85-
},
86-
"share_request":{
87-
"selected_grantee_capabilities":{
88-
"grn::::search:684158906442150b2eefb78c":"own"
89-
}
113+
"entity": {
114+
"index_set_id": "65b7ba138cdb8c534a953fef",
115+
"description": "An example stream",
116+
"title": "My Stream",
117+
"remove_matches_from_default_stream": false
118+
},
119+
"share_request": {
120+
"selected_grantee_capabilities": {
121+
"grn::::search:684158906442150b2eefb78c": "own"
90122
}
123+
}
91124
}
92125
```
93-
- Access to the API browser now requires the `api_browser:read` permission. This permission can be granted by assigning
126+
127+
- Access to the API browser now requires the `api_browser:read` permission. This permission can be granted by assigning
94128
the new “API Browser Reader” role to a user.
95129

96130
## REST API Endpoint Changes
97131

98132
The following REST API changes have been made.
99133

100-
| Endpoint | Description |
101-
|-----------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
102-
| `GET /system/urlallowlist` | Renamed from `GET /system/urlwhitelist`. The corresponding REST API permission is renamed to `urlallowlist:read`. |
103-
| `PUT /system/urlallowlist` | Renamed from `PUT /system/urlwhitelist` . The corresponding REST API permission is renamed to `urlallowlist:write` |
104-
| `POST /system/urlallowlist/check` | Renamed from `POST /system/urlwhitelist/check` |
105-
| `POST /system/urlallowlist/generate_regex` | Renamed from `POST /system/urlwhitelist/generate_regex` |
106-
| `GET /<endpoint>` | description |
134+
| Endpoint | Description |
135+
|---------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------|
136+
| `GET /system/urlallowlist` | Renamed from `GET /system/urlwhitelist`. The corresponding REST API permission is renamed to `urlallowlist:read`. |
137+
| `PUT /system/urlallowlist` | Renamed from `PUT /system/urlwhitelist`. The corresponding REST API permission is renamed to `urlallowlist:write` |
138+
| `POST /system/urlallowlist/check` | Renamed from `POST /system/urlwhitelist/check` |
139+
| `POST /system/urlallowlist/generate_regex` | Renamed from `POST /system/urlwhitelist/generate_regex` |
140+
| All `/api/plugins/org.graylog.plugins.datalake/data_lake/...` | Renamed from `/api/plugins/org.graylog.plugins.datawarehouse/data_warehouse/...`. The corresponding permissions are also renamed to `data_lake...` |
141+
| `GET /<endpoint>` | description |

api-specs/stream-output-filters.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -282,7 +282,7 @@ components:
282282
description: "The destination type"
283283
enum:
284284
- "indexer"
285-
- "data-warehouse"
285+
- "data-lake"
286286
title:
287287
type: "string"
288288
description: "The filter title"

changelog/unreleased/pr-23558.toml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
type = "c"
2+
message = "Renamed all remaining occurrences of 'Data Warehouse' to 'Data Lake'."
3+
4+
issues = ["Graylog2/graylog-plugin-enterprise#9752"]
5+
pulls = ["Graylog2/graylog-plugin-enterprise#1804", "23558", "Graylog2/e2e-tests#1285"]

graylog2-server/src/main/java/org/graylog/plugins/views/search/searchtypes/DataLakeSearchType.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,5 +23,5 @@
2323
*/
2424
public interface DataLakeSearchType extends SearchType {
2525

26-
String PREFIX = "data_warehouse_";
26+
String PREFIX = "data_lake_";
2727
}

graylog2-server/src/main/resources/org/graylog2/featureflag/feature-flag.config

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ configurable_value_units=on
8686
remote_reindex_migration=off
8787

8888
# Enable preview of Graylog-managed Data Lake data
89-
data_warehouse_search=on
89+
data_lake_search=on
9090

9191
# Enable preview of external Data Lake data (i.e. AWS)
9292
external_data_lake_search=on

graylog2-server/src/main/resources/prometheus-exporter.yml

Lines changed: 44 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -1265,96 +1265,96 @@ metric_mappings:
12651265
wildcard_extract_labels:
12661266
- "type"
12671267

1268-
- metric_name: "data_warehouse_s3_client_head_object"
1269-
match_pattern: "org.graylog.plugins.datawarehouse.s3client.*.HeadObject"
1268+
- metric_name: "data_lake_s3_client_head_object"
1269+
match_pattern: "org.graylog.plugins.datalake.s3client.*.HeadObject"
12701270
wildcard_extract_labels:
12711271
- "head_object"
12721272

1273-
- metric_name: "data_warehouse_s3_client_get_object"
1274-
match_pattern: "org.graylog.plugins.datawarehouse.s3client.*.GetObject"
1273+
- metric_name: "data_lake_s3_client_get_object"
1274+
match_pattern: "org.graylog.plugins.datalake.s3client.*.GetObject"
12751275
wildcard_extract_labels:
12761276
- "get_object"
12771277

1278-
- metric_name: "data_warehouse_s3_client_put_object"
1279-
match_pattern: "org.graylog.plugins.datawarehouse.s3client.*.PutObject"
1278+
- metric_name: "data_lake_s3_client_put_object"
1279+
match_pattern: "org.graylog.plugins.datalake.s3client.*.PutObject"
12801280
wildcard_extract_labels:
12811281
- "put_object"
12821282

1283-
- metric_name: "data_warehouse_s3_client_delete_object"
1284-
match_pattern: "org.graylog.plugins.datawarehouse.s3client.*.DeleteObject"
1283+
- metric_name: "data_lake_s3_client_delete_object"
1284+
match_pattern: "org.graylog.plugins.datalake.s3client.*.DeleteObject"
12851285
wildcard_extract_labels:
12861286
- "delete_object"
12871287

1288-
- metric_name: "data_warehouse_iceberg_file_io_s3_read"
1288+
- metric_name: "data_lake_iceberg_file_io_s3_read"
12891289
match_pattern: "org.graylog.iceberg.file.io.s3.read.*"
12901290
wildcard_extract_labels:
12911291
- "read"
12921292

1293-
- metric_name: "data_warehouse_iceberg_file_io_s3_write"
1293+
- metric_name: "data_lake_iceberg_file_io_s3_write"
12941294
match_pattern: "org.graylog.iceberg.file.io.s3.write.*"
12951295
wildcard_extract_labels:
12961296
- "write"
12971297

1298-
- metric_name: "data_warehouse_iceberg_file_io_local_write"
1298+
- metric_name: "data_lake_iceberg_file_io_local_write"
12991299
match_pattern: "org.graylog.iceberg.file.io.local.write"
13001300

1301-
- metric_name: "data_warehouse_iceberg_file_io_local_read"
1301+
- metric_name: "data_lake_iceberg_file_io_local_read"
13021302
match_pattern: "org.graylog.iceberg.file.io.local.read"
13031303

1304-
- metric_name: "data_warehouse_iceberg_file_io_gcs_write"
1304+
- metric_name: "data_lake_iceberg_file_io_gcs_write"
13051305
match_pattern: "org.graylog.iceberg.file.io.gcs.write.*"
13061306
wildcard_extract_labels:
13071307
- "write"
13081308

1309-
- metric_name: "data_warehouse_iceberg_file_io_gcs_read"
1309+
- metric_name: "data_lake_iceberg_file_io_gcs_read"
13101310
match_pattern: "org.graylog.iceberg.file.io.gcs.read.*"
13111311
wildcard_extract_labels:
13121312
- "read"
13131313

1314-
- metric_name: "data_warehouse_journal_writer_written_messages"
1315-
match_pattern: "org.graylog.plugins.datawarehouse.output.DataWarehouseJournalWriter.written-messages"
1314+
- metric_name: "data_lake_journal_writer_written_messages"
1315+
match_pattern: "org.graylog.plugins.datalake.output.DataLakeJournalWriter.written-messages"
13161316

1317-
- metric_name: "data_warehouse_journal_writer_written_bytes"
1318-
match_pattern: "org.graylog.plugins.datawarehouse.output.DataWarehouseJournalWriter.written-bytes"
1317+
- metric_name: "data_lake_journal_writer_written_bytes"
1318+
match_pattern: "org.graylog.plugins.datalake.output.DataLakeJournalWriter.written-bytes"
13191319

1320-
- metric_name: "data_warehouse_journal_writer_written_failed_write_attempts"
1321-
match_pattern: "org.graylog.plugins.datawarehouse.output.DataWarehouseJournalWriter.failed-write-attempts"
1320+
- metric_name: "data_lake_journal_writer_written_failed_write_attempts"
1321+
match_pattern: "org.graylog.plugins.datalake.output.DataLakeJournalWriter.failed-write-attempts"
13221322

1323-
- metric_name: "data_warehouse_journal_last_flush_time"
1324-
match_pattern: "org.graylog.plugins.datawarehouse.output.journal.lastFlushTime"
1323+
- metric_name: "data_lake_journal_last_flush_time"
1324+
match_pattern: "org.graylog.plugins.datalake.output.journal.lastFlushTime"
13251325

1326-
- metric_name: "data_warehouse_journal_log_end_offset"
1327-
match_pattern: "org.graylog.plugins.datawarehouse.output.journal.logEndOffset"
1326+
- metric_name: "data_lake_journal_log_end_offset"
1327+
match_pattern: "org.graylog.plugins.datalake.output.journal.logEndOffset"
13281328

1329-
- metric_name: "data_warehouse_journal_number_of_segments"
1330-
match_pattern: "org.graylog.plugins.datawarehouse.output.journal.numberOfSegments"
1329+
- metric_name: "data_lake_journal_number_of_segments"
1330+
match_pattern: "org.graylog.plugins.datalake.output.journal.numberOfSegments"
13311331

1332-
- metric_name: "data_warehouse_journal_read_messages"
1333-
match_pattern: "org.graylog.plugins.datawarehouse.output.journal.readMessages"
1332+
- metric_name: "data_lake_journal_read_messages"
1333+
match_pattern: "org.graylog.plugins.datalake.output.journal.readMessages"
13341334

1335-
- metric_name: "data_warehouse_journal_read_time"
1336-
match_pattern: "org.graylog.plugins.datawarehouse.output.journal.readTime"
1335+
- metric_name: "data_lake_journal_read_time"
1336+
match_pattern: "org.graylog.plugins.datalake.output.journal.readTime"
13371337

1338-
- metric_name: "data_warehouse_journal_recovery_point"
1339-
match_pattern: "org.graylog.plugins.datawarehouse.output.journal.recoveryPoint"
1338+
- metric_name: "data_lake_journal_recovery_point"
1339+
match_pattern: "org.graylog.plugins.datalake.output.journal.recoveryPoint"
13401340

1341-
- metric_name: "data_warehouse_journal_size"
1342-
match_pattern: "org.graylog.plugins.datawarehouse.output.journal.size"
1341+
- metric_name: "data_lake_journal_size"
1342+
match_pattern: "org.graylog.plugins.datalake.output.journal.size"
13431343

1344-
- metric_name: "data_warehouse_journal_uncommitted_messages"
1345-
match_pattern: "org.graylog.plugins.datawarehouse.output.journal.uncommittedMessages"
1344+
- metric_name: "data_lake_journal_uncommitted_messages"
1345+
match_pattern: "org.graylog.plugins.datalake.output.journal.uncommittedMessages"
13461346

1347-
- metric_name: "data_warehouse_journal_unflushed_messages"
1348-
match_pattern: "org.graylog.plugins.datawarehouse.output.journal.unflushedMessages"
1347+
- metric_name: "data_lake_journal_unflushed_messages"
1348+
match_pattern: "org.graylog.plugins.datalake.output.journal.unflushedMessages"
13491349

1350-
- metric_name: "data_warehouse_journal_write_discarded_messages"
1351-
match_pattern: "org.graylog.plugins.datawarehouse.output.journal.writeDiscardedMessages"
1350+
- metric_name: "data_lake_journal_write_discarded_messages"
1351+
match_pattern: "org.graylog.plugins.datalake.output.journal.writeDiscardedMessages"
13521352

1353-
- metric_name: "data_warehouse_journal_write_time"
1354-
match_pattern: "org.graylog.plugins.datawarehouse.output.journal.writeTime"
1353+
- metric_name: "data_lake_journal_write_time"
1354+
match_pattern: "org.graylog.plugins.datalake.output.journal.writeTime"
13551355

1356-
- metric_name: "data_warehouse_journal_written_messages"
1357-
match_pattern: "org.graylog.plugins.datawarehouse.output.journal.writtenMessages"
1356+
- metric_name: "data_lake_journal_written_messages"
1357+
match_pattern: "org.graylog.plugins.datalake.output.journal.writtenMessages"
13581358

13591359
- metric_name: "shared_thread_pools_daemon_scheduler_executor"
13601360
match_pattern: "org.graylog2.shared-thread-pools.scheduled-daemon-executor.*"

graylog2-server/src/test/java/org/graylog2/telemetry/rest/TelemetryTestHelper.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,8 +34,8 @@ public class TelemetryTestHelper {
3434
public static final String LICENSE = "license";
3535
static final String PLUGIN = "plugin";
3636
static final String SEARCH_CLUSTER = "search_cluster";
37-
public static final String DATA_WAREHOUSE_ACCOUNTED_OUTPUT = "data_warehouse_accounted_output_traffic_last_month";
38-
public static final String DATA_WAREHOUSE_NOT_ACCOUNTED_OUTPUT = "data_warehouse_not_accounted_output_traffic_last_month";
37+
public static final String DATA_LAKE_ACCOUNTED_OUTPUT = "data_lake_accounted_output_traffic_last_month";
38+
public static final String DATA_LAKE_NOT_ACCOUNTED_OUTPUT = "data_lake_not_accounted_output_traffic_last_month";
3939

4040
static final String DATA_NODES = "data_nodes";
4141

graylog2-web-interface/src/logic/telemetry/Constants.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -188,10 +188,10 @@ export const TELEMETRY_EVENT_TYPE = {
188188
STREAM_ITEM_DATA_ROUTING_STREAM_INDEXSET_UPDATE_OPENED: 'Stream Item Data Routing Stream IndexSet Update Opened',
189189
STREAM_ITEM_DATA_ROUTING_INDEXER_FILTER_UPDATE_OPENED: 'Stream Item Data Routing Indexer Filter Update Opened',
190190
STREAM_ITEM_DATA_ROUTING_INDEXER_FILTER_CREATE_OPENED: 'Stream Item Data Routing Indexer Filter Create Opened',
191-
STREAM_ITEM_DATA_ROUTING_DATA_WAREHOUSE_FILTER_CREATE_OPENED:
192-
'Stream Item Data Routing Data Warehouse Filter Create Opened',
193-
STREAM_ITEM_DATA_ROUTING_DATA_WAREHOUSE_FILTER_UPDATE_OPENED:
194-
'Stream Item Data Routing Data Warehouse Filter Update Opened',
191+
STREAM_ITEM_DATA_ROUTING_DATA_LAKE_FILTER_CREATE_OPENED:
192+
'Stream Item Data Routing Data Lake Filter Create Opened',
193+
STREAM_ITEM_DATA_ROUTING_DATA_LAKE_FILTER_UPDATE_OPENED:
194+
'Stream Item Data Routing Data Lake Filter Update Opened',
195195
STREAM_ITEM_DATA_ROUTING_FILTER_DELETE_OPENED: 'Stream Item Data Routing Filter Delete Opened',
196196
STREAM_ITEM_DATA_ROUTING_INTAKE_OPENED: 'Stream Item Data Routing Intake Opened',
197197
STREAM_ITEM_DATA_ROUTING_PROCESSING_OPENED: 'Stream Item Data Routing Processing Opened',

0 commit comments

Comments
 (0)