Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[O11y][SpringBoot] Add custom field for _id and update dashboard #5935

Merged
merged 4 commits into from
Apr 28, 2023
+269 −43
Merged

[O11y][SpringBoot] Add custom field for _id and update dashboard #5935

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
0617d24
Add custom field for _id and update dashboard
rajvi-patel-22 Apr 20, 2023
a98938d
Update changelog
rajvi-patel-22 Apr 20, 2023
a72ec42
Add troubleshooting section in README
rajvi-patel-22 Apr 24, 2023
4f19dd4
Address review comment and update README
rajvi-patel-22 Apr 25, 2023
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
93 changes: 93 additions & 0 deletions packages/spring_boot/_dev/build/docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,99 @@ In order to ingest data from Spring Boot:
</dependency>
```

### Troubleshooting

If **[Spring Boot] Audit Events panel** does not display older documents after upgrading to ``0.9.0`` or later versions, then this issue can be solved by reindexing the ``audit_events`` data stream's indices.

To reindex the data, the following steps must be performed.

1. Stop the data stream by going to `Integrations -> Spring Boot -> Integration policies` open the configuration of Spring Boot and disable the `Spring Boot Audit Events metrics` toggle to reindex ``audit_events`` data stream and save the integration.

2. Perform the following steps in the Dev tools.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For steps 2 , 4, 7 mention what is the goal of the step before the phrase - Perform the following steps in Dev Tools..


```
POST _reindex
{
"source": {
"index": "<index_name>"
},
"dest": {
"index": "temp_index"
}
}
```
Example:
```
POST _reindex
{
"source": {
"index": "logs-spring_boot.audit_events-default"
},
"dest": {
"index": "temp_index"
}
}
```

```
DELETE /_data_stream/<data_stream>
```
Example:
```
DELETE /_data_stream/logs-spring_boot.audit_events-default
```

```
DELETE _index_template/<index_template>
```
Example:
```
DELETE _index_template/logs-spring_boot.audit_events
```
3. Go to `Integrations -> Spring Boot -> Settings` and click on `Reinstall Spring Boot`.

4. Perform the following steps in the Dev tools.

```
POST _reindex
{
"source": {
"index": "temp_index"
},
"dest": {
"index": "<index_name>",
"op_type": "create"

}
}
```
Example:
```
POST _reindex
{
"source": {
"index": "temp_index"
},
"dest": {
"index": "logs-spring_boot.audit_events-default",
"op_type": "create"

}
}
```

5. Verify data is reindexed completely.

6. Start the data stream by going to the `Integrations -> Spring Boot -> Integration policies` and open configuration of integration and enable the `Spring Boot Audit Events metrics` toggle.

7. Perform the following step in the Dev tools

```
DELETE temp_index
```

More details about reindexing can be found [here](https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-reindex.html).

## Logs

### Audit Events logs
Expand Down
93 changes: 93 additions & 0 deletions packages/spring_boot/docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,99 @@ In order to ingest data from Spring Boot:
</dependency>
```

### Troubleshooting

If **[Spring Boot] Audit Events panel** does not display older documents after upgrading to ``0.9.0`` or later versions, then this issue can be solved by reindexing the ``audit_events`` data stream's indices.

To reindex the data, the following steps must be performed.

1. Stop the data stream by going to `Integrations -> Spring Boot -> Integration policies` open the configuration of Spring Boot and disable the `Spring Boot Audit Events metrics` toggle to reindex ``audit_events`` data stream and save the integration.

2. Perform the following steps in the Dev tools.

```
POST _reindex
{
"source": {
"index": "<index_name>"
},
"dest": {
"index": "temp_index"
}
}
```
Example:
```
POST _reindex
{
"source": {
"index": "logs-spring_boot.audit_events-default"
},
"dest": {
"index": "temp_index"
}
}
```

```
DELETE /_data_stream/<data_stream>
```
Example:
```
DELETE /_data_stream/logs-spring_boot.audit_events-default
```

```
DELETE _index_template/<index_template>
```
Example:
```
DELETE _index_template/logs-spring_boot.audit_events
```
3. Go to `Integrations -> Spring Boot -> Settings` and click on `Reinstall Spring Boot`.

4. Perform the following steps in the Dev tools.

```
POST _reindex
{
"source": {
"index": "temp_index"
},
"dest": {
"index": "<index_name>",
"op_type": "create"

}
}
```
Example:
```
POST _reindex
{
"source": {
"index": "temp_index"
},
"dest": {
"index": "logs-spring_boot.audit_events-default",
"op_type": "create"

}
}
```

5. Verify data is reindexed completely.

6. Start the data stream by going to the `Integrations -> Spring Boot -> Integration policies` and open configuration of integration and enable the `Spring Boot Audit Events metrics` toggle.

7. Perform the following step in the Dev tools

```
DELETE temp_index
```

More details about reindexing can be found [here](https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-reindex.html).

## Logs

### Audit Events logs
Expand Down