@grepr/cli 1.8.5-ca825ac → 1.8.7-20abddf

package/build/dist/docs-index/26df42b3-fe16-40ef-88c5-3570e871f3d8.txt

@@ -0,0 +1,38 @@
+# Get billing summary for one reporting period
+
+**GET** `/v1/billing/summary`
+
+**Operation ID**: `getSummary`
+**Summary**: Get billing summary for one reporting period
+Returns the per-period payload — contract bounds, reporting-period descriptor, and plan-specific commitment summary — for the authenticated user's organization. When no period is supplied, defaults to the period containing today.
+
+## Tags
+- Billing
+## Parameters
+
+- **period** (optional) - query
+  - Canonical period id ("YYYY-MM-DD", the period's start date) for both monthly and annual plans. Defaults to the period containing today when omitted.
+  - Type: string
+
+## Responses
+
+### 200
+
+Contract + reporting period + plan summary.
+
+- **Content-Type**: `application/json` / `BillingSummaryResponse`
+### 401
+
+Unauthorized
+
+### 403
+
+Forbidden
+
+### 404
+
+No billing record exists, no eligible subscription owns the requested period, or the subscription's plan template is unrecognized.
+
+### 500
+
+Internal Server Error

package/build/dist/docs-index/270c8740-b6bd-4791-a3a1-996e16c0c143.json

@@ -0,0 +1 @@
+{"docType":"schema"}

package/build/dist/docs-index/270c8740-b6bd-4791-a3a1-996e16c0c143.txt

@@ -0,0 +1,15 @@
+# BillingPeriodsResponse
+
+Static customer header data for the billing page: display name + selectable reporting periods.
+
+**Type**: `object`
+
+## Properties
+
+- name: customerName (required)
+  type: string
+  description: Customer display name (e.g. "ACME, Inc.").
+
+- name: periods (required)
+  type: array of `PeriodEntry`
+  description: Reporting periods available for this customer, newest first.

package/build/dist/docs-index/27481678-f498-4828-a96a-63d3c6cd1c48.json

@@ -0,0 +1 @@
+{"docType":"schema"}

package/build/dist/docs-index/27481678-f498-4828-a96a-63d3c6cd1c48.txt

@@ -0,0 +1,17 @@
+# TagNode
+
+**Type**: `object`
+
+## Properties
+
+- name: tagKey (required)
+  type: string
+  description: The tag key 
+
+- name: tagValue (required)
+  type: string
+  description: This is a string that is matched against the tag value.
+
+- name: type (required)
+  type: enum: `tag-node`
+  description: A node that represents a tag key and value in a parsed query.

package/build/dist/docs-index/275e9a9c-c6eb-4049-a8d0-197e88de3074.json

@@ -0,0 +1 @@
+{"docType":"schema"}

package/build/dist/docs-index/275e9a9c-c6eb-4049-a8d0-197e88de3074.txt

@@ -0,0 +1,16 @@
+# MetricDataRawIcebergTableSink
+
+**Type**: `object`
+
+## Properties
+
+- name: datasetId (required)
+  type: string
+  description: The id of the dataset to write to
+
+- name: name (required)
+  type: string
+
+- name: type (required)
+  type: enum: `metricdata-raw-iceberg-table-sink`
+  description: Writes MetricData (one row per datapoint, attributes auto-flattened to columns) to an Iceberg table.

package/build/dist/docs-index/27e2924d-364f-4be1-9a5b-a16ada5acb5f.json

@@ -0,0 +1 @@
+{"docType":"api"}

package/build/dist/docs-index/27e2924d-364f-4be1-9a5b-a16ada5acb5f.txt

@@ -0,0 +1,30 @@
+# Reset impact estimations for a pipeline
+
+**POST** `/v1/pipelines/{pipelineId}/exceptions/impact-estimation-reset`
+
+**Operation ID**: `resetImpactEstimation`
+**Summary**: Reset impact estimations for a pipeline
+Clears the cached impact percentage and last-updated timestamp on estimation rows in the pipeline's scope. The hourly impact-estimation cycle picks up the cleared rows on its next tick; fresh values appear on a later poll. Rows currently being processed by an active estimation job are skipped and retain their values until that job completes. Returns the number of rows cleared; zero indicates a no-op (no opted-in sink datasets, or no estimation-capable source integrations).
+
+## Tags
+- Pipeline Exceptions
+## Parameters
+
+- **pipelineId** (required) - path
+  - Pipeline ID to reset estimations for
+  - Type: string
+
+## Responses
+
+### 200
+
+Reset complete
+
+- **Content-Type**: `application/json` / `ResetImpactEstimationResponse`
+### 401
+
+Unauthorized
+
+### 404
+
+Not Found - Pipeline not found.

package/build/dist/docs-index/2818cbf7-3cfd-4fb0-ab96-ceb910886cea.json

@@ -0,0 +1 @@
+{"docType":"schema"}

package/build/dist/docs-index/2818cbf7-3cfd-4fb0-ab96-ceb910886cea.txt

@@ -0,0 +1,18 @@
+# AggType
+
+Aggregation function.
+
+**Type**: `string`
+
+## Possible Values
+
+- `LATEST`
+- `SUM`
+- `AVG`
+- `CUMULATIVE`
+- `CUMULATIVE_UPDOWN`
+- `DEFAULT`
+- `PERCENTILE`
+- `SLOPE`
+- `MAX`
+- `MIN`

package/build/dist/docs-index/281a402e-ed8a-4cd2-b1a1-ed9995fa0037.json

@@ -0,0 +1 @@
+{"docType":"schema"}

package/build/dist/docs-index/281a402e-ed8a-4cd2-b1a1-ed9995fa0037.txt

@@ -0,0 +1,5 @@
+# TimestampReadingStrategy
+
+Strategy to read files created after a specific timestamp
+
+**Type**: `object`

package/build/dist/docs-index/28457869-d305-4546-a551-ffd149439604.json

@@ -0,0 +1 @@
+{"docType":"doc"}

package/build/dist/docs-index/28457869-d305-4546-a551-ffd149439604.txt

@@ -0,0 +1,231 @@
+Learn how to create a Grepr pipeline, integrate the pipeline with your observability platform, such as Datadog, Splunk, or New Relic, and use that pipeline to lower your observability costs by dynamically reducing shipped log volumes.
+
+# Tutorial: Build your first Grepr pipeline
+
+This tutorial is an end-to-end example that shows you how Grepr dynamically reduces the volume of shipped logs without losing data. It does this by walking you through an example that integrates Grepr with Datadog, creates a Grepr pipeline that processes log events forwarded from Datadog agents, and sends the resulting events to Datadog.
+
+In this tutorial, you:
+
+1. Verify that you can directly send log events from your local environment to Datadog.
+2. Configure a Grepr integration with Datadog.
+3. Configure a Grepr storage integration to store raw logs in the Grepr data lake.
+4. Create a Grepr pipeline that processes raw logs and sends the resulting processed events to Datadog.
+5. Use Docker to simulate multiple hosts sending log events to Grepr by running multiple Datadog agents in your local environment.
+6. Run the pipeline and view the output in the Grepr and Datadog UIs.
+
+> * This tutorial uses Datadog as the observability tool. However, you can use this tutorial to create a pipeline that integrates with any Grepr-supported observability tool. For the complete list of supported observability vendors, see [Grepr supported vendor and storage integrations](/integrations/support-matrix).
+> * To show you the most direct way to create a pipeline in the Grepr UI, this tutorial walks you through creating an end-to-end pipeline directly in the Grepr pipeline editor. However, to give you more control over configurations, the Grepr UI also includes separate interfaces to configure pipeline components such as integrations.
+> * This tutorial shows you how to send logs to Grepr using Datadog agents running in local Docker containers. However, if you have existing infrastructure forwarding logs to Datadog, you can use that infrastructure for this example. The Grepr Datadog integration also supports log collectors other than Datadog agents. To learn more about supported collectors, including configuration details, see [Configure Datadog connections with a Grepr integration](/integrations/datadog).
+
+## Requirements
+
+To complete this tutorial, you must have:
+
+* A Grepr account and a login to your organization's Grepr UI. If you don't have a Grepr account, sign up at <https://app.grepr.ai/signup>.
+* An organization identifier. A 3–31 character identifier containing only lowercase letters, numbers, and hyphens. If you don't have one, create an organization ID when you sign up for a Grepr account.
+* An account with an observability vendor supported by Grepr. This tutorial uses Datadog. If you don't have a Datadog account, you can sign up for a free trial at [www.datadoghq.com](https://www.datadoghq.com). For the complete list of supported observability vendors, see [Grepr supported vendor and storage integrations](/integrations/support-matrix).
+* A Datadog API key for your account. You can retrieve this from your Datadog Organization Settings or copy it from the Agent Setup page instructions.
+* The Datadog site parameter that the Datadog agents should use. This parameter is determined by the Datadog site you selected. For example, if you select `US1`, the site parameter's value is `datadoghq.com`.
+* A Docker installation in your local environment. Docker is used to run the Datadog agents that send log events to Grepr.
+
+## Step 1: Verify that agents can send events to Datadog
+
+Before working through this tutorial, you should verify that Datadog agents running in your local environment can send log events directly to Datadog. In a terminal window, run the following command, replacing `DD_API_KEY_VALUE` with your Datadog API key and `DD_SITE_VALUE` with your Datadog site parameter. Optionally replace `DD_HOSTNAME` with a preferred hostname for testing. This value can be used in the Datadog UI to filter incoming log events:
+
+```bash
+docker run --rm --name dd-agent \
+-e DD_API_KEY=DD_API_KEY_VALUE \
+-e DD_SITE="datadoghq.com" \
+-e DD_LOGS_ENABLED=true \
+-e DD_LOGS_CONFIG_CONTAINER_COLLECT_ALL=true \
+-e DD_HOSTNAME=my-test-host \
+-v /var/run/docker.sock:/var/run/docker.sock:ro \
+-v /proc/:/host/proc/:ro \
+-v /sys/fs/cgroup/:/host/sys/fs/cgroup:ro \
+gcr.io/datadoghq/agent:latest
+```
+
+While this command runs, go to the Datadog UI, click **Logs**, and then click **Live Tail**. If everything's working correctly, you see log events arriving from the Datadog agent.
+
+To learn more about the Datadog Docker Agent, including details for the configuration options, see the [Datadog documentation](https://docs.datadoghq.com/containers/docker/).
+
+When you've finished testing, shut down the agent by running the following command in a separate terminal:
+
+```bash
+docker stop dd-agent
+```
+
+## Step 2: Create a Grepr pipeline to process log events
+
+A Grepr pipeline defines the steps to process log data. Pipelines you create in the Grepr UI implement a flow with the following steps to reduce the volume of log data sent to your observability platform:
+
+* Read logs from one or more sources. Sources use Grepr integrations that connect Grepr to external systems, such as observability vendors or cloud storage providers. This tutorial guides you through creating a source that uses a Grepr Datadog integration.
+
+* Filter log events at several stages in the pipeline.
+
+* Extract structured data from unstructured log messages or attributes using the Grepr Grok parser. See the [Grok parser](/transforms/grok) documentation.
+
+* Persist the raw logs into your Grepr data lake. To add a data lake in the pipeline editor, you must have a Grepr storage integration and a Grepr dataset configured.
+
+  * The storage integration is used to ensure retention of all data by storing raw logs in low-cost cloud storage. This tutorial uses a storage integration that uses a Grepr-hosted Amazon S3 bucket.
+  * The dataset defines a namespace in your storage specifying where the raw logs are stored.
+
+* Reduce the amount of log data to forward to your observability platform through the log reducer. To learn more about the log reducer, see [Reduce shipped data volumes with the Grepr log reducer](/transforms/reducer).
+
+* Send the result of processing the logs to one or more sinks. Like sources, sinks use a configured Grepr integration.
+
+To create pipelines with more complex functionality, you can use the Grepr REST API. See the [Job creation API guide](/apis/job-creation-guide).
+
+To create a new pipeline:
+
+1. In the Grepr UI, click **Home** in the navigation menu, then click **Create Pipeline**.
+
+2. In the **Create Pipeline** dialog, enter a name for your new pipeline.
+
+3. Click **Create**.
+
+After clicking **Create**, the pipeline editor view appears. The left pane displays the flow for a log reduction pipeline. In the next step, you begin configuring the pipeline by adding a source.
+
+### Add a source for Datadog logs
+
+To add a source in the pipeline editor, you first configure a Grepr integration. To create an integration and add a source:
+
+1. Click **Continue** in the pipeline editor view.
+
+2. Click **Add integration**.
+
+3. In the **Add Observability Vendor** dialog:
+
+   * In the **Type** menu, select **Datadog**.
+   * In the **Name** field, enter a name for the integration.
+   * In the **Site** menu, select the parameter matching your Datadog site.
+   * In the **API Key** field, enter your Datadog API key.
+   * Leave the **Application Key** field empty.
+
+4. Click **Create**.
+
+   After clicking **Create**, Grepr validates the API key with Datadog, creates the integration, and returns a success message. If any issues are found, an error message is returned instead.
+
+5. In the **Add source** dialog, select the Datadog integration you created in the previous step. A name for this source is automatically added for you.
+
+6. Click **Submit**.
+
+### Add a data lake
+
+To add a Grepr data lake to retain raw log data, you first configure a Grepr storage integration. To create a storage integration and add a data lake to your pipeline:
+
+1. Click **Data Lake** in the left pane, then click **Add**.
+
+2. In the **Add Data Lake** dialog:
+
+   * In the **Type** menu, select **Grepr-hosted**.
+   * In the **Name** field, enter a name for the integration.
+
+3. Click **Next**.
+
+4. In the **Dataset Name** field, enter a name for the dataset to contain raw data. This can be any name you choose, but it should be descriptive.
+
+5. In the **Integration** menu, select the storage integration you created in the previous step.
+
+6. Click **Add**.
+
+To send the processed logs to Datadog, a sink is automatically added to your pipeline. Click **Sinks** in the left pane to view the sink. Under **Additional Tags / Attributes**, you can see automatically populated tags. These tags are appended to messages before they're sent to Datadog. Grepr recommends retaining these tags because they allow you to distinguish Grepr-processed logs from other logs.
+
+## Step 3: Create and start the pipeline
+
+Click **Create Pipeline** in the top bar, then click **Confirm** in the **Create pipeline** dialog. Your pipeline will shortly go from **Starting** to **Running**. When the pipeline reaches the **Running** state, it's ready to start processing logs. In the next step, you simulate sending log messages through your pipeline.
+
+## Step 4: Simulate multiple agents sending logs through Grepr
+
+1. Before sending log messages to your pipeline, make sure no Docker containers are running the Datadog agent. In a terminal, run the following command:
+
+   ```bash
+   docker stop dd-agent
+   ```
+
+2. To configure the Datadog agents to send logs to Grepr, you need the Grepr ingestion URL. To find the URL, click **Sources** in the left pane and copy the **Ingest URL** value.
+
+3. To start five agents to send logs through Grepr, run the following command, replacing `INGESTION_URL` with the Grepr ingestion URL you copied above, and `DD_API_KEY_VALUE` with your Datadog API key:
+
+   ```bash
+   for i in $(seq 1 5); do docker run -d --rm --name dd-agent-$i \
+   -e DD_API_KEY=DD_API_KEY_VALUE \
+   -e DD_SITE="datadoghq.com" \
+   -e DD_LOGS_ENABLED=true \
+   -e DD_LOGS_CONFIG_CONTAINER_COLLECT_ALL=true \
+   -e DD_HOSTNAME=my-test-host-$i \
+   -v /var/run/docker.sock:/var/run/docker.sock:ro \
+   -v /proc/:/host/proc/:ro \
+   -v /sys/fs/cgroup/:/host/sys/fs/cgroup:ro \
+   -e DD_LOGS_CONFIG_LOGS_DD_URL=INGESTION_URL \
+   -e DD_LOGS_CONFIG_USE_HTTP="true" \
+   gcr.io/datadoghq/agent:latest; done
+   ```
+
+   This command starts five agents, each with a different hostname. There are two new environment variables added to the command: `DD_LOGS_CONFIG_LOGS_DD_URL` and `DD_LOGS_CONFIG_USE_HTTP`. The first variable provides the agents with the Grepr URL to send logs to, and the second variable tells the agents to use HTTPS instead of TCP when sending logs to Grepr.
+
+   > Before sending logs for ingestion, ensure there's at least one running pipeline that includes a Datadog source that matches the Datadog integration you created in Step 2. If a pipeline doesn't exist, the ingestion requests are not accepted.
+
+## View the results
+
+After the agents are running, to monitor log ingestion activity, go to the Grepr Pipelines UI and select **Overview**.
+
+To see the logs arriving to Datadog, go to the Datadog **Log Explorer**. To filter for only messages arriving from your test agents, enter `host:my-test-host*` in the **Filter your logs** text box.
+
+When you scroll through the logs in the Datadog **Log Explorer**, you can see that repeated log events are aggregated. This aggregation, which reduces the data volumes sent to Datadog, is the result of the Grepr log reducer. To learn more about the log reducer, see [Reduce shipped data volumes with the Grepr log reducer](/transforms/reducer).
+
+## Cleaning up
+
+When you've finished the tutorial, you can stop the Datadog agents by running the following command in a terminal:
+
+```bash
+for i in $(seq 1 5); do docker stop dd-agent-$i; done
+```
+
+To stop the pipeline, go to the Grepr UI home page, click the **More options** icon (⋮) in the top-right corner of the pipeline card, select **Stop**, and then confirm that you would like to stop the pipeline.
+
+## Next steps
+
+To see an example of troubleshooting incidents with Grepr and Datadog, see the [troubleshooting tutorial](/tutorials/troubleshooting-example).
+
+## Frequently Asked Questions
+
+### What is a Grepr pipeline?
+
+A Grepr pipeline is a configurable data processing workflow that reads logs from sources, applies filters and transformations, optionally stores raw logs in a data lake, reduces log volume using intelligent aggregation, and sends processed logs to sinks. Pipelines allow you to dynamically control log volumes without losing important data.
+
+### How do I create my first Grepr pipeline?
+
+To create your first pipeline, sign in to the Grepr UI, click 'Create Pipeline' on the Home page, enter a name, and click Create. The pipeline editor will open where you can add sources, configure integrations, set up storage, and create sinks. This tutorial walks through the complete process with a Datadog example.
+
+### What observability platforms does Grepr support?
+
+Grepr supports multiple observability vendors, including Datadog, Splunk, New Relic, and others. For a complete list of supported platforms and regions, see the Grepr supported vendor and storage integrations documentation.
+
+### Do I need a Datadog account to follow this tutorial?
+
+Yes, this tutorial uses Datadog as an example. However, you can follow the same steps with any Grepr-supported observability platform. If you don't have a Datadog account, sign up for a free trial at www\.datadoghq.com or use your preferred observability platform.
+
+### What is the log reducer and how does it work?
+
+The log reducer is a Grepr component that intelligently aggregates repeated log events into summary messages, reducing the volume of logs sent to your observability platform. It identifies patterns in logs and uses placeholders for varying fields, allowing you to maintain visibility while reducing storage and processing costs.
+
+### How do I configure a Datadog integration in Grepr?
+
+To configure a Datadog integration, click 'Add integration' in the pipeline editor, select Datadog as the Type, enter a name for the integration, select your Datadog site from the menu, and enter your Datadog API key. Click Create and Grepr will validate the API key with Datadog.
+
+### What is the Grepr data lake and why do I need it?
+
+The Grepr data lake is a storage system that retains all raw log data in low-cost cloud storage using a Grepr-hosted Amazon S3 bucket. It ensures you don't lose any data while using the log reducer and allows you to backfill logs or perform historical analysis later.
+
+### How do I monitor logs flowing through my pipeline?
+
+You can monitor log ingestion in the Grepr Pipelines UI by selecting 'Overview' to see real-time event metrics. Additionally, go to your observability platform (Datadog, Splunk, etc.) to see the processed logs after reduction. In Datadog, filter using labels like 'host:my-test-host\*' to see logs from your test agents.
+
+### What happens to logs after the log reducer aggregates them?
+
+After the log reducer aggregates logs into summary messages, they are sent to your observability platform sinks. The summary messages include metadata like repeat count, first/last timestamps, and a pattern ID, allowing you to trace back to raw logs stored in the data lake if needed.
+
+### Can I test my pipeline changes before applying them to production?
+
+Yes, Grepr provides a live edit feature that allows you to safely test changes to your pipeline without impacting production. Live edit creates a temporary copy of your pipeline and excludes sinks, preventing duplicate data from being sent to your observability platform.

package/build/dist/docs-index/28b000e3-fc3f-42cb-aa54-7d4561929056.json

@@ -0,0 +1 @@
+{"docType":"schema"}

package/build/dist/docs-index/28b000e3-fc3f-42cb-aa54-7d4561929056.txt

@@ -0,0 +1,8 @@
+# RoleUpdate
+
+**Type**: `object`
+
+## Properties
+
+- name: roleIds (required)
+  type: array of string

package/build/dist/docs-index/296a5a65-9aa8-4861-bf15-f445c6a00642.json

@@ -0,0 +1 @@
+{"docType":"schema"}

package/build/dist/docs-index/296a5a65-9aa8-4861-bf15-f445c6a00642.txt

@@ -0,0 +1,11 @@
+# PlanChangeRequest
+
+**Type**: `object`
+
+## Properties
+
+- name: date (required)
+  type: string
+
+- name: type (required)
+  type: enum: `TRIAL`, `FREE`, `INVOICE`

package/build/dist/docs-index/29f1e396-859e-4689-99d0-b3584643cdf1.json

@@ -0,0 +1 @@
+{"docType":"api"}

package/build/dist/docs-index/29f1e396-859e-4689-99d0-b3584643cdf1.txt

@@ -0,0 +1,32 @@
+# Get reporting periods + customer display name
+
+**GET** `/v1/billing/periods`
+
+**Operation ID**: `getPeriods`
+**Summary**: Get reporting periods + customer display name
+Returns the customer display name plus reporting periods available for the authenticated user's organization. Returns 404 when no billing record exists for the customer or no eligible subscription has any closed orders.
+
+## Tags
+- Billing
+## Responses
+
+### 200
+
+Customer name + period list.
+
+- **Content-Type**: `application/json` / `BillingPeriodsResponse`
+### 401
+
+Unauthorized
+
+### 403
+
+Forbidden
+
+### 404
+
+Not Found
+
+### 500
+
+Internal Server Error

package/build/dist/docs-index/2a325115-5899-4451-b008-fb5e5d280b53.json

@@ -0,0 +1 @@
+{"docType":"doc"}

package/build/dist/docs-index/2a325115-5899-4451-b008-fb5e5d280b53.txt

@@ -0,0 +1,169 @@
+Learn how to create a Sumo Logic integration and use it to add sources that ingest logs to a Grepr pipeline for processing and sinks that send the processed logs to Sumo Logic.
+
+# Configure Sumo Logic connections with a Grepr integration
+
+The Grepr platform includes two integrations for connecting to Sumo Logic. This page documents the Sumo Logic integration, but the integration to use depends on the source type that you are sending logs to:
+
+* If you use the OTLP/HTTP source in Sumo Logic, you must use the [Grepr OpenTelemetry integration](/integrations/open-telemetry) to connect Grepr and Sumo Logic.
+* If you use the HTTP source, you must use the Sumo Logic integration.
+
+To send logs to a Grepr pipeline before forwarding them to Sumo Logic, update your collector configuration to send the logs to a Grepr endpoint URL instead of the endpoint for a Sumo Logic source. To learn how to create a Sumo Logic integration in the Grepr UI and configure collectors to send logs to Grepr, see [Use a Sumo Logic integration in a Grepr pipeline](#use-sumo-logic-integration).
+
+You can also use the Grepr REST API to create and use a Sumo Logic integration. See the [Sumo Logic Integration specification](/apis/api-spec#tag/Sumo-Logic-Integration).
+
+> Although this page describes using an integration to create a pipeline for sourcing and sending data with a single observability platform, your pipelines can use multiple integrations to source and sink data for different platforms. For example, you can create a pipeline with a Datadog integration that's used to source data from Datadog agents, and a Splunk integration and sink that sends the pipeline output to Splunk.
+
+## Requirements
+
+* To create a Sumo Logic integration, you must have the endpoint URL from a configured `HTTP Logs and Metrics Source`. See [Configure an HTTP Logs and Metrics Source](https://www.sumologic.com/help/docs/send-data/hosted-collectors/http-source/logs-metrics/#configure-an-httplogs-and-metrics-source).
+* The only log format supported by the Sumo Logic integration is JSON. To send logs to a Grepr source, you must set `log_format:json` in your collector configuration.
+
+## Use a Sumo Logic integration in a Grepr pipeline \[#use-sumo-logic-integration]
+
+Use the following steps to create a Sumo Logic integration in the Grepr UI and use it in a pipeline to source and sink logs.
+
+### Step 1: Create a Sumo Logic integration
+
+To create a Sumo Logic integration in the Grepr UI:
+
+1. Go to the **Integrations** page in the Grepr UI and click **Add new** next to **Observability Vendors**.
+
+2. In the **Add Observability Vendor** dialog:
+
+   * In the **Type** menu, select **Sumo Logic**.
+   * In the **Name** field, enter a name for the integration. To facilitate working with logs in Sumo Logic, Grepr recommends naming the integration based on the collector that will send logs to Grepr.
+   * In the **HTTP collector URL** field, enter the endpoint URL from your Sumo Logic `HTTP Logs and Metrics Source`.
+
+3. Click **Create**.
+
+   #### Optional: Grant team access to the integration
+
+   When you have teams in your Grepr organization, you can grant access to the integration to one or more of those teams. To configure team access when you create or edit an integration:
+
+   1. In the **Grant Team Access** section, click the plus sign icon (+).
+
+   2. Select the team or teams that should be granted access to the integration.
+
+   3. Click **Create**.
+
+   To learn more, see [Manage teams in the Grepr platform](/admin/manage-teams) and [Permissions in the Grepr platform](/grepr-platform/permissions).
+
+### Step 2: Add a source to your pipeline
+
+To add a source to your pipeline that uses the Sumo Logic integration:
+
+1. In the Grepr UI, go to the details page for an existing pipeline or create a new pipeline from the homepage.
+2. In the left-hand navigation menu on the pipeline details page, click **Sources**.
+3. In the **Add source** dialog, select the Sumo Logic integration in the **Source** menu.
+4. Optional: In the **Name** field, to override the Grepr-generated name, enter a new name for the source.
+5. Click **Submit**.
+
+### Step 3: Configure log forwarding to Grepr
+
+To send data to Grepr, you configure your collector or agent to send it to the ingestion URL for your Grepr integration, rather than to your observability vendor's platform. To find the ingestion URL when using the Grepr UI to configure your pipeline, go to the details page for the pipeline, click **Sources** in the left pane, and copy the **Ingest URL**.
+
+
+
+If you connect to Grepr through AWS PrivateLink, copy the private ingestion URL and use it in place of the public ingestion URL. To learn more about sending data to Grepr over AWS PrivateLink, see [Securely forward observability data to Grepr with AWS PrivateLink](/admin/private-link).
+
+When you use the API, you can construct the ingestion URL using the following format:
+
+`https://<integration-id>-<org-id>.ingest.grepr.ai/receiver/v1/http/<unique-http-collector>`
+
+Replace `<integration-id>` with the identifier of the vendor integration used by your pipeline and replace `<org-id>` with the identifier for your organization.
+
+To use the PrivateLink endpoint service, insert `.private` after the `ingest` host segment.
+
+Although all sources created from the same integration share the same ingestion URL, you can use a single integration to create sources for multiple pipelines. The Grepr platform ensures events are routed to the correct pipelines.
+
+Also replace `{$UNIQUE_HTTP_COLLECTOR}` with the unique identifier for your Sumo Logic `HTTP Logs and Metrics Source`.
+
+The `Sumo Logic Distribution for OpenTelemetry Collector` is supported for sending logs to Grepr. To configure the OpenTelemetry collector to send logs to Grepr, set the `endpoint` value in the `exporters.sumologic` section to the ingestion URL from your Grepr source:
+
+```yaml
+exporters:
+  sumologic/grepr:
+    endpoint: <ingestion-url>
+    log_format: json
+
+service:
+  pipelines:
+    logs:
+      exporters: [sumologic/grepr]
+```
+
+Replace:
+
+* `<ingestion-url>` with the ingestion URL from your Grepr Sumo Logic source.
+
+Your workflow might require sending unprocessed logs directly to Sumo Logic in addition to sending the logs to Grepr. To configure dual-shipping of logs, include an exporter configuration for both Grepr and Sumo Logic in your OpenTelemetry collector configuration:
+
+```yaml
+exporters:
+  sumologic/grepr:
+    endpoint: <ingestion-url>
+    log_format: json
+
+  # Your existing Sumo Logic exporter
+  sumologic:
+    endpoint: <sumo-http-source-url>
+    log_format: json
+
+service:
+  pipelines:
+    logs:
+      exporters: [sumologic/grepr, sumologic]
+```
+
+Replace:
+
+* `<ingestion-url>` with the ingestion URL from your Grepr Sumo Logic source.
+* `<sumo-http-source-url>` with the endpoint URL from your Sumo Logic HTTP source.
+
+To learn more about configuration settings for the Sumo Logic OpenTelemetry Collector, see the [Sumo Logic Distribution for OpenTelemetry Collector documentation](https://github.com/SumoLogic/sumologic-otel-collector#readme).
+
+## Limitations
+
+The integration doesn't support Sumo Logic [Extended HTTP Metadata Collection](https://www.sumologic.com/help/docs/manage/fields/#extended-http-metadata-collection). Grepr drops any custom headers forwarded by collectors before processing the messages included in the payload.
+
+## Frequently Asked Questions
+
+### How do I send logs from Sumo Logic to Grepr?
+
+To send logs from Sumo Logic to Grepr, configure your collector to send logs to the Grepr ingestion URL instead of your Sumo Logic HTTP Logs and Metrics Source. The ingestion URL format is https\://\<integration-id>-\<org-id>.ingest.grepr.ai/receiver/v1/http/\<unique-http-collector>. Replace the unique-http-collector with the identifier from your Sumo Logic HTTP source.
+
+### What is required to create a Sumo Logic integration with Grepr?
+
+You need the endpoint URL from a configured HTTP Logs and Metrics Source in Sumo Logic. You must also ensure your logs are in JSON format, as the Sumo Logic integration only supports JSON log format. Set log_format:json in your collector configuration.
+
+### How do I configure the Sumo Logic OpenTelemetry Collector to send logs to Grepr?
+
+In your Sumo Logic Distribution for OpenTelemetry Collector configuration, set the endpoint value in the exporters.sumologic section to your Grepr ingestion URL. Set log_format to 'json'. You can also configure dual-shipping by including both Grepr and Sumo Logic exporters in your pipeline.
+
+### Why must logs be in JSON format for the Sumo Logic integration?
+
+The Grepr Sumo Logic integration is designed to work with JSON-formatted logs to ensure proper parsing and processing. If your logs are not in JSON format, you need to configure your collectors to convert them to JSON before sending to Grepr.
+
+### Can I dual-ship logs to both Grepr and Sumo Logic?
+
+Yes, you can configure your OpenTelemetry collector to send logs to both Grepr and Sumo Logic. In your collector configuration, add two exporters: one pointing to your Grepr ingestion URL and another pointing to your Sumo Logic endpoint. Both can be included in your logs pipeline.
+
+### What is the difference between Sumo Logic HTTP source and OTLP/HTTP source?
+
+Sumo Logic offers two types of sources: HTTP Logs and Metrics Source for traditional HTTP-based log collection, and OTLP/HTTP source for OpenTelemetry protocol data. If you use OTLP/HTTP, you must use the Grepr OpenTelemetry integration instead of the Sumo Logic integration.
+
+### How do I find the unique HTTP collector identifier for my Sumo Logic source?
+
+When you create an HTTP Logs and Metrics Source in Sumo Logic, the endpoint URL contains the unique collector identifier. It appears at the end of the URL path. You'll need this identifier to construct the complete Grepr ingestion URL.
+
+### Does Grepr support Sumo Logic Extended HTTP Metadata Collection?
+
+No, Grepr does not support Sumo Logic Extended HTTP Metadata Collection. Grepr drops any custom headers forwarded by collectors before processing the log messages in the payload.
+
+### How can I reduce storage costs with the Sumo Logic integration?
+
+After ingesting logs into Grepr through the Sumo Logic integration, you can use Grepr's log reducer and transformation features to reduce log volume before sending processed logs back to Sumo Logic. This helps optimize storage costs in Sumo Logic.
+
+### What if my logs are not in JSON format when using Sumo Logic integration?
+
+The Sumo Logic integration only supports JSON format. If your logs are in a different format, you need to configure your collector to parse and convert them to JSON before sending to Grepr. Most collectors like Fluentd and OpenTelemetry Collector support log parsing and transformation.

package/build/dist/docs-index/2a839d51-46ec-49a5-a187-0f52918b6a5c.json

@@ -0,0 +1 @@
+{"docType":"doc"}