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

DOCS-434 - Ingest Budgets V1 deprecation #4583

Draft
wants to merge 4 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from 1 commit
Commits
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
2 changes: 1 addition & 1 deletion blog-developer/2019/12-31.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Update - The [Collector Management API](/docs/api/collector-management) can retu

---
## June 17, 2019 - APIs
New - The [Ingest Budget Management API](/docs/api/ingest-budget-v1) allows you to manage [ingest budgets](/docs/manage/ingestion-volume/ingest-budgets) from HTTP endpoints.
New - The [Ingest Budget Management API](/docs/api/ingest-budget-v2) allows you to manage [ingest budgets](/docs/manage/ingestion-volume/ingest-budgets) from HTTP endpoints.

#### Deprecation Notice

Expand Down
3 changes: 2 additions & 1 deletion cid-redirects.json
Original file line number Diff line number Diff line change
Expand Up @@ -1323,7 +1323,7 @@
"/07Sumo-Logic-Apps/Partner_Integrations": "/docs/integrations/partner-integrations",
"/07Sumo-Logic-Apps/08Reference-Information-for-Sumo-Logic-Apps/Supported-Data-Formats": "/docs/get-started/system-requirements",
"/APIs": "/docs/api",
"/APIs/Ingest_Budget_Management_API": "/docs/api/ingest-budget-v1",
"/APIs/Ingest_Budget_Management_API": "/docs/api/ingest-budget-v2",
"/APIs/Access_Keys_Management_API": "/docs/api/access-keys",
"/APIs/Account_Management_API": "/docs/api/account-management",
"/APIs/Alerts-API": "/docs/api",
Expand Down Expand Up @@ -1360,6 +1360,7 @@
"/APIs/Metrics-API": "/docs/api/metrics",
"/APIs/Metrics-API/About-Metrics-API": "/docs/api/metrics",
"/APIs/Metrics_Query_API": "/docs/api/metrics-query",
"/docs/api/ingest-budget-v1": "/docs/api/ingest-budget-v2",
"/APIs/Ingest_Budget_Management_API_V2": "/docs/api/ingest-budget-v2",
"/APIs/General-API-Information/API-Authentication": "/docs/api/getting-started",
"/APIs/General_API_Information/API_Authentication": "/docs/api/getting-started",
Expand Down
5 changes: 0 additions & 5 deletions docs/api/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,11 +100,6 @@ To connect with other Sumo Logic users, post feedback, or ask a question, visit
<a href="/docs/api/health-events"><img src={useBaseUrl('img/icons/company-value/heart-wellness.png')} alt="Thumbnail icon" width="50"/><h4>Health Events</h4></a>
</div>
</div>
<div className="box smallbox card">
<div className="container">
<a href="/docs/api/ingest-budget-v1"><img src={useBaseUrl('img/icons/operations/data-volume.png')} alt="Thumbnail icon" width="50"/><h4>Ingest Budget V1</h4></a>
</div>
</div>
<div className="box smallbox card">
<div className="container">
<a href="/docs/api/ingest-budget-v2"><img src={useBaseUrl('img/icons/operations/data-volume.png')} alt="Thumbnail icon" width="50"/><h4>Ingest Budget V2</h4></a>
Expand Down
55 changes: 0 additions & 55 deletions docs/api/ingest-budget-v1.md

This file was deleted.

6 changes: 2 additions & 4 deletions docs/api/ingest-budget-v2.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,8 @@ import ApiRoles from '../reuse/api-roles.md';

The Ingest Budget Management V2 APIs allow you to manage metadata-based [ingest budgets](/docs/manage/ingestion-volume/ingest-budgets) (with a scope) from HTTP endpoints.

You can use [V1 APIs](/docs/api/ingest-budget-v1) to manage ingest budgets with a Field Value.

:::note
[V1 budgets](/docs/api/ingest-budget-v1) will be deprecated September 16, 2024.
Ingest Budget Management V1 APIs have been deprecated.
:::

## Prerequisites
Expand Down Expand Up @@ -52,4 +50,4 @@ You can use [V1 APIs](/docs/api/ingest-budget-v1) to manage ingest budgets with

-->

To manage ingest budgets, you must have the **Manage Ingest Budgets** role capability. Enabling this will automatically enable the **Manage Collectors** capability. The Manage Collectors capability on its own permits the re-assignment of budgets to different Collectors, but not creating or deleting them. For more information, see [Ingest Budgets](/docs/manage/ingestion-volume/ingest-budgets).
To manage ingest budgets, you must have the **Manage Ingest Budgets** role capability. Enabling this will automatically enable the **Manage Collectors** capability. The Manage Collectors capability on its own permits the re-assignment of budgets to different Collectors, but not creating or deleting them. For more information, see [Ingest Budgets](/docs/manage/ingestion-volume/ingest-budgets).
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: Assign Collector to Ingest Budget
description: Learn how to assign a Collector to an ingest budget.
---


<!-- What content is impacted by v1 deprecation? -->
## Availability

| Account Type | Account Level |
Expand All @@ -19,13 +19,9 @@ Once you have created an ingest budget you can assign a Collector to it. You ca

The UI installer for Installed Collectors does not support assigning ingest budgets, use another method.

:::note
Assigning an Ingest Budget to a Collector is only relevant for V1 Ingest Budgets. V2 Ingest Budgets assign budgets to your log data by **Fields** or built-in metadata fields, and do not use the reserved **`_budget`** field.
:::

## Collection page

On the [Collection page](/docs/send-data/collection) when editing an existing Collector or creating a new Hosted Collector there is an option, **Assign to a Budget**, that allows you to assign an ingest budget to a Collector.
On the [Collection page](/docs/send-data/collection), when editing an existing Collector or creating a new Hosted Collector, there is an option, **Assign to a Budget**, that allows you to assign an ingest budget to a Collector.

![assign to a budget dropdown option.png](/img/ingestion-volume/assign-budget-dropdown-option.png)

Expand Down Expand Up @@ -55,15 +51,13 @@ Use the [Collector Management API](/docs/api/collector-management) to assign an

The following steps can be referenced in the [Collector Management API document for a PUT request](/docs/api/collector-management/collector-api-methods-examples). If you are not sure what URL endpoint to use see [Sumo Logic Endpoints](/docs/api/getting-started#sumo-logic-endpoints-by-deployment-and-firewall-security "Sumo Logic Endpoints and Firewall Security").

First make a GET request to get the Collector's JSON configuration:
First, make a `GET` request to get the Collector's JSON configuration:

```bash
curl -v -u 'accessid:accesskey' https://api.sumologic.com/api/v1/collectors/15
```

GET response:

```
```json title="GET response"
...
< ETag: "acd8c6f11f5100b047e6320f231c4f6f"
...
Expand Down Expand Up @@ -131,7 +125,7 @@ Updating a Collector also requires the "If-Match" header to be specified with th
curl -u 'accessid:accesskey' -X PUT -H "Content-Type: application/json" -H "If-Match: \"acd8c6f11f5100b047e6320f231c4f6f\"" -T updated_collector.json https://api.sumologic.com/api/v1/collectors/15
```

The response has the updated JSON and the Collector is now assigned to the ingest budget with a Field Value of `sumo_budget` :
The response has the updated JSON and the Collector is now assigned to the ingest budget with a Field Value of `sumo_budget`:

```json
{
Expand Down Expand Up @@ -161,7 +155,7 @@ The response has the updated JSON and the Collector is now assigned to the inge

## user.properties

When registering a new Collector you can specify the parameter `fields` in [user.properties](/docs/send-data/installed-collectors/collector-installation-reference/user-properties.md) to assign the Collector to an existing ingest budget.
When registering a new Collector, you can specify the parameter `fields` in [user.properties](/docs/send-data/installed-collectors/collector-installation-reference/user-properties.md) to assign the Collector to an existing ingest budget.

| Parameter | Description | Can be changed after installation? |
|:--|:--|:--|
Expand Down
22 changes: 11 additions & 11 deletions docs/manage/ingestion-volume/ingest-budgets/daily-volume/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ For example, a **Scope** expression like `_sourceCategory=/dev/catalog/*` im
See more [budget assignment examples](#budget-assignment-examples) below and review the [rules](#rules) above.

## Versions

<!-- impacted by v1 deprecation -->
There are two versions of ingest budgets:

* V1 ingest budgets are older and have a **Field Value** for Collector assignment. They are shown with a **V1** in the **Name** cell.<br/> ![v1 budget tag.png](/img/ingestion-volume/v1-budget-tag.png)
Expand All @@ -52,6 +52,7 @@ There are two versions of ingest budgets:

## Migrating V1 budgets to V2

<!-- impacted by v1 deprecation -->
* You can edit an existing **V1** budget by providing a **scope** to change it to a **V2** budget that is metadata-based.
* V2 budgets are manageable with the [Ingest Budget Management **V2** API](/docs/api/ingest-budget-v2).
* V1 budgets will be deprecated on September 16, 2024.
Expand All @@ -72,18 +73,17 @@ A few Sources on Hosted Collectors behave differently when instructed to stop co

## Tools

* [Ingest Budget Management API V2](/docs/api/ingest-budget-v1.md)
* [Ingest Budget Management API V1](/docs/api/ingest-budget-v2.md)
* [Ingest Budget Management API V2](/docs/api/ingest-budget-v2.md)
* Terraform provider: [sumologic_ingest_budget_v2](https://registry.terraform.io/providers/SumoLogic/sumologic/latest/docs/resources/ingest_budget_v2)

## Manage ingest budgets

Use the **Ingest Budgets** page to manage your ingest budgets.
Use the **Ingest Budgets** page to manage your ingest budgets.

[**Classic UI**](/docs/get-started/sumo-logic-ui-classic). To access the Ingest Budgets page, in the main Sumo Logic menu select **Manage Data > Collection > Ingest Budgets**.

[**Classic UI**](/docs/get-started/sumo-logic-ui-classic). To access the Ingest Budgets page, in the main Sumo Logic menu select **Manage Data > Collection > Ingest Budgets**.
[**New UI**](/docs/get-started/sumo-logic-ui/). To access the Ingest Budgets page, in the top menu select **Configuration**, and then under **Data Collection** select **Ingest Budget**. You can also click the **Go To...** menu at the top of the screen and select **Ingest Budget**.

[**New UI**](/docs/get-started/sumo-logic-ui/). To access the Ingest Budgets page, in the top menu select **Configuration**, and then under **Data Collection** select **Ingest Budget**. You can also click the **Go To...** menu at the top of the screen and select **Ingest Budget**.


![metadata ingest budgetspage.png](/img/ingestion-volume/metadata-ingest-budgets-page.png)

Expand Down Expand Up @@ -117,7 +117,7 @@ When hovering over a row in the Ingest Budgets table there are icons that appear

#### Create ingest budget

1. [**Classic UI**](/docs/get-started/sumo-logic-ui-classic). In the main Sumo Logic menu, select **Manage Data > Collection > Ingest Budgets**. <br/>[**New UI**](/docs/get-started/sumo-logic-ui). In the top menu select **Configuration**, and then under **Data Collection** select **Ingest Budget**. You can also click the **Go To...** menu at the top of the screen and select **Ingest Budget**.
1. [**Classic UI**](/docs/get-started/sumo-logic-ui-classic). In the main Sumo Logic menu, select **Manage Data > Collection > Ingest Budgets**. <br/>[**New UI**](/docs/get-started/sumo-logic-ui). In the top menu select **Configuration**, and then under **Data Collection** select **Ingest Budget**. You can also click the **Go To...** menu at the top of the screen and select **Ingest Budget**.
1. Click the **+ Add Budget** button on the top right of the table. A panel named **Create Ingest Budget** appears to the right of the Ingest Budgets table.
1. Provide the following information, all fields are required except Description.

Expand Down Expand Up @@ -146,19 +146,19 @@ When hovering over a row in the Ingest Budgets table there are icons that appear

You can manually reset a budget at any time to set its capacity utilization tracking to zero. This won't affect the next scheduled reset time and can be done as many times as needed.

1. [**Classic UI**](/docs/get-started/sumo-logic-ui-classic). In the main Sumo Logic menu, select **Manage Data > Collection > Ingest Budgets**. <br/>[**New UI**](/docs/get-started/sumo-logic-ui). In the top menu select **Configuration**, and then under **Data Collection** select **Ingest Budget**. You can also click the **Go To...** menu at the top of the screen and select **Ingest Budget**.
1. [**Classic UI**](/docs/get-started/sumo-logic-ui-classic). In the main Sumo Logic menu, select **Manage Data > Collection > Ingest Budgets**. <br/>[**New UI**](/docs/get-started/sumo-logic-ui). In the top menu select **Configuration**, and then under **Data Collection** select **Ingest Budget**. You can also click the **Go To...** menu at the top of the screen and select **Ingest Budget**.
1. In the table find the ingest budget you want to reset and click the row to open its details pane.
1. Click the **Reset** button.

#### Edit ingest budget

1. [**Classic UI**](/docs/get-started/sumo-logic-ui-classic). In the main Sumo Logic menu, select **Manage Data > Collection > Ingest Budgets**. <br/>[**New UI**](/docs/get-started/sumo-logic-ui). In the top menu select **Configuration**, and then under **Data Collection** select **Ingest Budget**. You can also click the **Go To...** menu at the top of the screen and select **Ingest Budget**.
1. [**Classic UI**](/docs/get-started/sumo-logic-ui-classic). In the main Sumo Logic menu, select **Manage Data > Collection > Ingest Budgets**. <br/>[**New UI**](/docs/get-started/sumo-logic-ui). In the top menu select **Configuration**, and then under **Data Collection** select **Ingest Budget**. You can also click the **Go To...** menu at the top of the screen and select **Ingest Budget**.
1. In the table find the ingest budget you want to edit and click the edit icon ![pencil edit icon.png](/img/ingestion-volume/pencil-edit-icon.png) on the right of the row or click the row and then click the edit icon in the details panel.
1. Make your changes and click **Update**.

#### Delete ingest budget

1. [**Classic UI**](/docs/get-started/sumo-logic-ui-classic). In the main Sumo Logic menu, select **Manage Data > Collection > Ingest Budgets**. <br/>[**New UI**](/docs/get-started/sumo-logic-ui). In the top menu select **Configuration**, and then under **Data Collection** select **Ingest Budget**. You can also click the **Go To...** menu at the top of the screen and select **Ingest Budget**.
1. [**Classic UI**](/docs/get-started/sumo-logic-ui-classic). In the main Sumo Logic menu, select **Manage Data > Collection > Ingest Budgets**. <br/>[**New UI**](/docs/get-started/sumo-logic-ui). In the top menu select **Configuration**, and then under **Data Collection** select **Ingest Budget**. You can also click the **Go To...** menu at the top of the screen and select **Ingest Budget**.
kimsauce marked this conversation as resolved.
Show resolved Hide resolved
1. In the table find the ingest budget you want to delete and click the delete icon ![delete trash icon.png](/img/ingestion-volume/delete-trash-icon.png) on the right of the row or click the row and then click the delete icon in the details panel.
1. You will get a confirmation prompt, ensure that you are deleting the desired ingest budget and then click **Delete**.

Expand Down
Loading
Loading