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.

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

Events docs revamp #8360

Merged
merged 15 commits into from
Oct 8, 2024
Merged
Original file line number Diff line number Diff line change
Expand Up @@ -348,15 +348,15 @@ Because a feature flag service controls how an application behaves in production

Unleash provides the data to log any change over time at the flag level and at the project level. Logs are useful for downstream data warehouses or data lakes. Tools like [Splunk](https://www.splunk.com/) can help you combine logs and run advanced queries against them.

For our Python app, we can view Event logs to monitor the changes to flag strategies and statuses we have made throughout our examples, such as:
For our Python app, we can view events in [Event Log](/reference/events#event-log) to monitor the changes to flag strategies and statuses we have made throughout our examples, such as:

- When the flag was created
- How the gradual rollout strategy was configured
- When and how the variants were created and configured

![Event logs in Unleash track every single change made to flags, similar to Git commit history.](/img/python-ex-logs.png)
![Event Log in Unleash tracks every single change made to flags, similar to Git commit history.](/img/python-ex-logs.png)

You can also retrieve event log data by using an API command below:
You can also retrieve events by using an API command below:

```py
import requests
Expand All @@ -374,7 +374,7 @@ response = requests.request("GET", url, headers=headers, data=payload)
print(response.text)
```

Read our documentation on [Event logs](/reference/event-log) and [APIs](/reference/api/unleash/get-events-for-toggle) to learn more.
Read our documentation on [Event Log](/reference/events#event-log) and [APIs](/reference/api/unleash/get-events-for-toggle) to learn more.

## Flag Automation and Workflow Integration for Django Apps

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -312,15 +312,15 @@ This is especially true in very regulated environments like health care, insuran

Unleash provides the data to log any change over time at the flag level and at the project level. Logs are useful for downstream data warehouses or data lakes.

You can view Event logs to monitor the changes to flag strategies and statuses, like:
You can view [Event Log](/reference/events#event-log) to monitor the changes to flag strategies and statuses, like:

- When the flag was created
- How the gradual rollout strategy was configured
- When and how the variants were created and configured

![Event logs in Unleash track every single change made to flags, similar to Git commit history.](../ruby/event-logs.png)
![Event Log in Unleash tracks every single change made to flags, similar to Git commit history.](../ruby/event-logs.png)

You can also retrieve event logs by using an API command, like below:
You can also retrieve events by using an API command, like below:

```csharp
HttpClient client = new HttpClient();
Expand All @@ -336,7 +336,7 @@ var responseBody = await response.Content.ReadAsStringAsync();
Console.WriteLine(responseBody);
```

Read our documentation on [Event logs](/reference/event-log) and [APIs](/reference/api/unleash/get-events-for-toggle) to learn more.
Read our documentation on [Event Log](/reference/events#event-log) and [APIs](/reference/api/unleash/get-events-for-toggle) to learn more.

## Flag Automation and Workflow Integration for .NET Apps

Expand Down
8 changes: 4 additions & 4 deletions website/docs/feature-flag-tutorials/ios/examples.md
Original file line number Diff line number Diff line change
Expand Up @@ -274,23 +274,23 @@ Because a feature flag service controls how an application behaves in production

Unleash provides the data to log any change over time at the flag level and at the project level. Logs are useful for downstream data warehouses or data lakes. Tools like [Splunk](https://www.splunk.com/) can help you combine logs and run advanced queries against them.

For our iOS app, we can view Event logs to monitor the changes to flag strategies and statuses we have made throughout our examples, such as:
For our iOS app, we can view events in [Event Log](/reference/events#event-log) to monitor the changes to flag strategies and statuses we have made throughout our examples, such as:

- When the flag was created
- How the gradual rollout strategy was configured
- When and how the variants were created and configured

![Feature flag event log. The flag's variant's have been updated.](/img/ios-ex-event-logs.png)
![Feature flag events showing that the flag's variants have been updated.](/img/ios-ex-event-logs.png)

You can also retrieve event log data by using an API command below:
You can also retrieve events by using the API command below:

```
curl -L -X GET '<your-unleash-url>/api/admin/events/:featureName' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'
```

Read our documentation on [Event logs](/reference/event-log) and [APIs](/reference/api/unleash/events) to learn more.
Read our documentation on [Event Log](/reference/events#event-log) and [APIs](/reference/api/unleash/events) to learn more.

## Change Management & Feature Flag Approvals in iOS

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -216,15 +216,15 @@ Because a feature flag service controls how an application behaves in production

Unleash provides the data to log any change over time at the flag level and the project level. Logs are useful for downstream data warehouses or data lakes. Tools like Splunk can help you combine logs and run advanced queries against them.

For our Spring Boot app, we can view Event logs to monitor the changes to flag strategies and statuses we have made throughout our examples, such as:
For our Spring Boot app, we can view events in [Event Log](/reference/events#event-log) to monitor the changes to flag strategies and statuses we have made throughout our examples, such as:

- When the flag was created
- How the gradual rollout strategy was configured
- When and how the variants were created and configured

![Event logs in Unleash track every single change made to flags, similar to Git commit history.](/img/spring-boot-events-log.png)
![Event Log in Unleash tracks every single change made to flags, similar to Git commit history.](/img/spring-boot-events-log.png)

You can also retrieve event log data by using an API command. Read our documentation on [Event logs](/reference/event-log) and [APIs](/reference/api/unleash/get-events-for-toggle) to learn more.
You can also retrieve events by using an API command. Read our documentation on [Event Log](/reference/events#event-log) and [APIs](/reference/api/unleash/get-events-for-toggle) to learn more.

## Flag Automation & Workflow Integration for Java Apps

Expand Down
8 changes: 4 additions & 4 deletions website/docs/feature-flag-tutorials/python/examples.md
Original file line number Diff line number Diff line change
Expand Up @@ -347,15 +347,15 @@ Because a feature flag service controls how an application behaves in production

Unleash provides the data to log any change over time at the flag level and at the project level. Logs are useful for downstream data warehouses or data lakes. Tools like [Splunk](https://www.splunk.com/) can help you combine logs and run advanced queries against them.

For our Python app, we can view Event logs to monitor the changes to flag strategies and statuses we have made throughout our examples, such as:
For our Python app, we can view events in [Event Log](/reference/events#event-log) to monitor the changes to flag strategies and statuses we have made throughout our examples, such as:

- When the flag was created
- How the gradual rollout strategy was configured
- When and how the variants were created and configured

![Event logs in Unleash track every single change made to flags, similar to Git commit history.](/img/python-ex-logs.png)
![Event Log in Unleash tracks every single change made to flags, similar to Git commit history.](/img/python-ex-logs.png)

You can also retrieve event log data by using an API command below:
You can also retrieve events by using the API command below:

```py
import requests
Expand All @@ -373,7 +373,7 @@ response = requests.request("GET", url, headers=headers, data=payload)
print(response.text)
```

Read our documentation on [Event logs](/reference/event-log) and [APIs](/reference/api/unleash/get-events-for-toggle) to learn more.
Read our documentation on [Event Log](/reference/events#event-log) and [APIs](/reference/api/unleash/get-events-for-toggle) to learn more.

## Flag Automation & Workflow Integration for Python Apps

Expand Down
8 changes: 4 additions & 4 deletions website/docs/feature-flag-tutorials/rails/rails-examples.md
Original file line number Diff line number Diff line change
Expand Up @@ -309,15 +309,15 @@ This is especially true in very regulated environments like health care, insuran

Unleash provides the data to log any change over time at the flag level and at the project level. Logs are useful for downstream data warehouses or data lakes.

You can view Event logs to monitor the changes to flag strategies and statuses, like:
You can view events in [Event Log](/reference/events#event-log) to monitor the changes to flag strategies and statuses, like:

- When the flag was created
- How the gradual rollout strategy was configured
- When and how the variants were created and configured

![Event logs in Unleash track every single change made to flags, similar to Git commit history.](../ruby/event-logs.png)
![Event Log in Unleash tracks every single change made to flags, similar to Git commit history.](../ruby/event-logs.png)

You can also retrieve event logs by using an API command, like below:
You can also retrieve events by using an API command, like below:

```ruby
require 'httpx'
Expand All @@ -333,7 +333,7 @@ response = HTTPX.get(url, headers: headers)
puts response.body
```

Read our documentation on [Event logs](/reference/event-log) and [APIs](/reference/api/unleash/get-events-for-toggle) to learn more.
Read our documentation on [Event Log](/reference/events#event-log) and [APIs](/reference/api/unleash/get-events-for-toggle) to learn more.

## Flag Automation and Workflow Integration for Rails Apps

Expand Down
8 changes: 4 additions & 4 deletions website/docs/feature-flag-tutorials/react/examples.md
Original file line number Diff line number Diff line change
Expand Up @@ -400,23 +400,23 @@ Fortunately, this is straightforward in Unleash Enterprise.

Unleash provides the data to log any change that has happened over time, at the flag level from a global level. In conjunction with Unleash, tools like [Splunk](https://www.splunk.com/) can help you combine logs and run advanced queries against them. Logs are useful for downstream data warehouses or data lakes.

In our React tutorial application, we can view Event logs to monitor the changes to flag strategies and statuses we have made throughout our examples, such as:
For our React tutorial application, we can view events in [Event Log](/reference/events#event-log) to monitor the changes to flag strategies and statuses we have made throughout our examples, such as:

- When the `newNotificationsBadge` flag was created
- How the gradual rollout strategy was configured
- When and how the variants were created and configured

![Feature flag event log. The flag's variant's have been updated.](/img/react-ex-event-log.png)
![Feature flag events showing that the flag's variants have been updated.](/img/react-ex-event-log.png)

You can also retrieve event log data by using an API command below:
You can also retrieve events by using the API command below:

```
curl -L -X GET '<your-unleash-url>/api/admin/events/:featureName' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'
```

Read our documentation on [Event logs](/reference/event-log) and [APIs](/reference/api/unleash/events) to learn more.
Read our documentation on [Event Log](/reference/events#event-log) and [APIs](/reference/api/unleash/events) to learn more.

## Change Management & Feature Flag Approvals in React

Expand Down
8 changes: 4 additions & 4 deletions website/docs/feature-flag-tutorials/ruby/ruby-examples.md
Original file line number Diff line number Diff line change
Expand Up @@ -308,15 +308,15 @@ This is especially true in very regulated environments like health care, insuran

Unleash provides the data to log any change over time at the flag level and at the project level. Logs are useful for downstream data warehouses or data lakes.

You can view Event logs to monitor the changes to flag strategies and statuses, like:
You can view [Event Log](/reference/events#event-log) to monitor the changes to flag strategies and statuses, like:

- When the flag was created
- How the gradual rollout strategy was configured
- When and how the variants were created and configured

![Event logs in Unleash track every single change made to flags, similar to Git commit history.](./event-logs.png)
![Event Log in Unleash tracks every single change made to flags, similar to Git commit history.](./event-logs.png)

You can also retrieve event logs by using an API command, like below:
You can also retrieve events by using an API command, like below:

```ruby
require 'httpx'
Expand All @@ -332,7 +332,7 @@ response = HTTPX.get(url, headers: headers)
puts response.body
```

Read our documentation on [Event logs](/reference/event-log) and [APIs](/reference/api/unleash/get-events-for-toggle) to learn more.
Read our documentation on [Event Log](/reference/events#event-log) and [APIs](/reference/api/unleash/get-events-for-toggle) to learn more.

## Flag Automation & Workflow Integration for Ruby Apps

Expand Down
8 changes: 4 additions & 4 deletions website/docs/feature-flag-tutorials/rust/rust-examples.md
Original file line number Diff line number Diff line change
Expand Up @@ -372,15 +372,15 @@ This is especially true in very regulated environments like health care, insuran

Unleash provides the data to log any change over time at the flag level and at the project level. Logs are useful for downstream data warehouses or data lakes.

You can view Event logs to monitor the changes to flag strategies and statuses, like:
You can view events in [Event Log](/reference/events#event-log) to monitor the changes to flag strategies and statuses, like:

- When the flag was created
- How the gradual rollout strategy was configured
- When and how the variants were created and configured

![Event logs in Unleash track every single change made to flags, similar to Git commit history.](../ruby/event-logs.png)
![Event Log in Unleash tracks every single change made to flags, similar to Git commit history.](../ruby/event-logs.png)

You can also retrieve event logs by using an API command, like below:
You can also retrieve events by using an API command, like below:

```rust
use reqwest::blocking::Client;
Expand All @@ -406,7 +406,7 @@ fn main() -> Result<(), Box<dyn Error>> {
}
```

Read our documentation on [Event logs](/reference/event-log) and [APIs](/reference/api/unleash/get-events-for-toggle) to learn more.
Read our documentation on [Event Log](/reference/events#event-log) and [APIs](/reference/api/unleash/get-events-for-toggle) to learn more.

## Flag Automation and Workflow Integration for Rust Apps

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -164,9 +164,9 @@ Fortunately, this is straightforward in Unleash Enterprise.

Unleash provides the data to log any change that has happened over time, at the flag level from a global level. In conjunction with Unleash, tools like Splunk can help you combine logs and run advanced queries against them. Logs are useful for downstream data warehouses or data lakes.

![The event log for a feature flag. The "Event log" tab is highlighted and the UI shows the most recent changes, including a JSON diff and the change details.](/img/unleash-toggle-history.png)
![Events for a feature flag. The Event log tab is highlighted and the UI shows the most recent changes, including a JSON diff and the change details.](/img/unleash-toggle-history.png)

Learn more about [event logs](/reference/event-log/) in our documentation.
Learn more about [Event Log](/reference/events#event-log/) in our documentation.

### Managing Change Requests

Expand Down
4 changes: 2 additions & 2 deletions website/docs/how-to/how-to-use-the-admin-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,9 @@ curl -X POST -H "Content-Type: application/json" \
https://app.unleash-hosted.com/demo/api/admin/features/Demo/toggle/on
```

**Great success!** We have now enabled the feature flag. We can also verify that it was actually changed by the API user by navigating to the Event log (history) for this feature flag.
**Great success!** We have now enabled the feature flag. We can also verify that it was actually changed by the API user by navigating to [Event Log](/reference/events#event-log) and filtering events for this feature flag.

![A feature flag's event log showing that it was last updated by "admin-api".](/img/api_access_history.png)
![Feature flag events showing that it was last updated by "admin-api".](/img/api_access_history.png)

## API overview {#api-overview}

Expand Down
2 changes: 1 addition & 1 deletion website/docs/reference/actions.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ Filters are completely optional, so if you don't configure any filter your actio

### Actions

When these actions are triggered, they will execute under the identity of a [service account](./service-accounts.md). This means that when you later check the [event log](./event-log) you will see this service account as the actor for those events. In order to execute the configured actions successfully, this service account needs to have the necessary permissions. This service account doesn't need an API token, so when creating it you can skip the token generation step and simply make sure it has the necessary permissions.
When these actions are triggered, they execute using the identity of a [service account](./service-accounts.md). As a result, when you later view events in [Event Log](./events#event-log), you’ll see this service account listed as the actor for those events. In order to execute the configured actions successfully, this service account needs to have the necessary permissions. This service account doesn't need an API token, so when creating it you can skip the token generation step and simply make sure it has the necessary permissions.

The actions are executed in the same order that they are defined. If a previous action fails, the following actions will not be started. You can add multiple actions to an action set and you can add multiple action sets to a project. Depending on the action you want to execute you will have to provide different parameters.

Expand Down
2 changes: 1 addition & 1 deletion website/docs/reference/api-tokens-and-client-keys.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ We do not recommend using admin tokens anymore, they are not connected to any us

**Personal access tokens** are a special form of admin tokens and grant access to the same resources that the user that created them has access to. These permissions are dynamic, so if a user's permissions change through addition of a custom role, the token will likewise have altered permissions.

When using a personal access token to modify resources, the event log will list the token creator's name for that operation.
When you use a personal access token to modify resources, the events record the token creator's name for that operation.

Personal access tokens with a lifetime **will stop working after the expiration date**.

Expand Down
4 changes: 2 additions & 2 deletions website/docs/reference/api/legacy/unleash/admin/events.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ In order to access the admin API endpoints you need to identify yourself. Unless

:::

The Events API lets you retrieve [events](/reference/event-types.mdx) from your Unleash instance.
The Events API lets you retrieve [events](/reference/events.mdx) from your Unleash instance.

## Event endpoints

Expand Down Expand Up @@ -131,6 +131,6 @@ The list of events related to the given toggle.

:::note Content moved

This section has been moved to a dedicated [event type reference document](/reference/event-types.mdx).
This section has been moved to a dedicated [events documentation](/reference/events.mdx).

:::
21 changes: 0 additions & 21 deletions website/docs/reference/event-log.md

This file was deleted.

Loading
Loading