@grepr/cli 1.2.0 → 1.3.0-4e666db

package/build/dist/docs-index/2452ff58-9f0c-48b8-ac90-9041be03a528.txt

@@ -1,203 +0,0 @@
----
-description: Learn how to create and use a New Relic integration to ingest logs to a Grepr pipeline for processing and send the processed logs to your New Relic instance.
----
-
-import { Callout } from 'nextra/components'
-import AddTeamAccess from '@/app/shared/add-team-access-to-resource.mdx'
-import IngestUrlConfig from '@/app/shared/configure-ingest-url.mdx'
-import IntegrationsInterchangeability from '@/app/shared/integrations-interchangeability.mdx'
-import { Tabs } from 'nextra/components'
-import { HiddenFAQ } from '@/components/HiddenFAQ'
-
-# Configure New Relic connections for integration with Grepr
-
-The New Relic integration enables you to ingest logs into Grepr with a Grepr source, process them with a Grepr pipeline, and then send the processed logs to New Relic with a Grepr sink.
-
-To send logs to a Grepr pipeline before forwarding the logs to New Relic, you change your collector configuration to send the logs to a Grepr endpoint URL instead of a New Relic endpoint. The Grepr New Relic integration supports the Fluent Bit and Fluentd collectors.
-
-You can use the Grepr UI or REST API to add a New Relic integration. To learn how to create a New Relic integration in the Grepr UI and configure collectors to send logs to Grepr, see [Use a New Relic integration in a Grepr pipeline](#use-newrelic-integration).
-
-To use the REST API, see the [New Relic Integration specification](/apis/api-spec#tag/New-Relic-Integration).
-
-<Callout>
-  <IntegrationsInterchangeability />
-</Callout>
-
-## Requirements
-
-- To create a New Relic integration, you must have a license key from your New Relic account. Use the same license key as the collectors that forward logs to New Relic. This key is required to authenticate the connection between Grepr and New Relic.
-- (Optional) To enable Grepr's automatic exception parsing feature, you must have the Account ID and a user key from your New Relic account. See [Enable selective reduction with a New Relic integration](#enable-selective-reduction). The user key must match the one the New Relic collectors use.
-
-## Enable selective reduction with a New Relic integration [#enable-selective-reduction]
-
-When you include a New Relic user key and account ID in your integration configuration, Grepr automatically tracks dashboards and alerts configured in your New Relic account. By parsing queries used in these dashboards and alerts and making them available as exceptions to the Log Reducer, Grepr can determine which messages should not be processed.
-
-To see a full list of exceptions from the parsed alerts and dashboards, in the **Observability vendors** section of the **Integrations** page in the Grepr UI, click on the cloud sync icon under **Actions**.
-
-To learn more about Grepr log reduction, see [Optimizing logs with Grepr's intelligent aggregation](/grepr-platform/reduction).
-
-## Use a New Relic integration in a Grepr pipeline [#use-newrelic-integration]
-
-Use the following steps to create a New Relic integration in the Grepr UI and use it in a pipeline to source and sink data.
-
-### Step 1: Create a New Relic integration
-
-To create a New Relic integration in the Grepr UI:
-
-1. Go to the **Integrations** page in the Grepr UI and click **Add new** next to **Observability Vendors**.
-
-   ![The Integrations page in the Grepr UI.](/images/tutorials/first-pipeline/integrations-page.png)
-
-1. In the **Add Observability Vendor** dialog:
-   - In the **Type** menu, select **New Relic**.
-   - In the **Name** field, enter a name for the integration.
-   - In the **License Key** field, enter the license key from your New Relic account. Use the same license key as the collectors that forward logs to New Relic. Do not enter a user key in this field.
-   - (Optional) Enter the **Account ID** for your New Relic account. This value is only required if you choose to enable Grepr's automatic exception parsing feature.
-   - (Optional) In the **User Key** field, enter a New Relic user key. Use the same user key that the New Relic collectors use. This value is only required if you choose to enable Grepr's automatic exception parsing feature.
-   - (Optional) Specify how recently a dashboard must have been accessed to be included in automatic exception parsing. By default, Grepr checks for activity within the last 28 days.
-1. Click **Create**.
-
-   #### (Optional) Grant team access to the integration
-
-   <AddTeamAccess resource_type='integration' />
-
-### Step 2: Add a source to your pipeline
-
-To add a source to your pipeline that uses the New Relic integration:
-
-1. In the Grepr UI, go to the overview page for an existing pipeline or create a new pipeline from the homepage.
-1. In the left-hand navigation menu on the pipeline overview page, click **Sources**.
-1. In the **Add source** dialog, select the New Relic integration in the **Source** menu.
-1. Click **Submit**.
-
-### Step 3: Configure log forwarding to Grepr
-
-<IngestUrlConfig image_url='/images/integrations/ingestion-url-newrelic.png' url='https://<integration-id>-<org-id>.ingest.grepr.ai/nr/log/v1' />
-
-To see more information and configuration examples, select the tab for your preferred log collector:
-
-<Tabs items={['Fluent Bit', 'Fluentd']}>
-  <Tabs.Tab>
-
-    Fluent Bit can forward logs using the New Relic output plugin. To configure the plugin, set the `endpoint` value to the ingestion URL from your integration and set the `licenseKey` value to your New Relic license key. The following is an example `OUTPUT` section from a Fluent Bit configuration file (`fluent-bit.conf`):
-
-    ```fluent
-    [OUTPUT]
-        Name       newrelic
-        Match      *
-        licenseKey <nr-license-key>
-        endpoint   <ingestion-url>
-    ```
-
-    Replace:
-    - `<nr-license-key>` with your New Relic license key.
-    - `<ingestion-url>` with the ingestion URL from your New Relic integration.
-
-    Fluent Bit can also be configured to dual-ship logs to New Relic and Grepr. To do this, add another `[OUTPUT]` section to the `fluent-bit.conf` file for New Relic:
-
-    ```fluent
-    # Send logs to New Relic directly
-    [OUTPUT]
-        Name       newrelic
-        Match      *
-        licenseKey <nr-license-key>
-
-    # Send logs to Grepr
-    [OUTPUT]
-        Name       newrelic
-        Match      *
-        licenseKey <nr-license-key>
-        endpoint   <ingestion-url>
-    ```
-
-    To learn more about configuration settings for Fluent Bit, see the documentation for the [Fluent Bit New Relic output plugin](https://docs.fluentbit.io/manual/pipeline/outputs/new-relic).
-
-  </Tabs.Tab>
-
-  <Tabs.Tab>
-
-    Fluentd can forward logs to Grepr using the `fluent-plugin-newrelic` output plugin. To configure the plugin, add a `match` directive to the Fluentd configuration. The following is an example `match` directive from a Fluentd configuration file (`fluentd.conf`):
-
-    ```fluent
-    <match your_tag.**> # Adjust your match pattern as needed
-      @type newrelic
-      license_key <nr-license-key>
-      base_uri <ingestion-url>
-    </match>
-    ```
-
-    Replace:
-    - `your_tag.**` with the tag of the logs you want to forward to Grepr or use `**` to match all tags.
-    - `<nr-license-key>` with your New Relic license key.
-    - `<ingestion-url>` with the ingestion URL from your New Relic integration.
-
-    To dual-ship logs, use the `copy` output plugin:
-
-    ```fluent
-    <match your_tag.**>
-      @type copy
-      <store>
-        @type newrelic
-        license_key <nr-license-key>
-        base_uri <ingestion-url>
-      </store>
-      <store>
-        @type newrelic
-        license_key <nr-license-key>
-      </store>
-    </match>
-    ```
-
-    To learn more about configuration settings for Fluentd, see the documentation for the [Fluentd New Relic output plugin](https://github.com/newrelic/newrelic-fluentd-output#readme).
-
-  </Tabs.Tab>
-</Tabs>
-
-## Limitations
-
-- The New Relic integration supports only HTTP/HTTPS connections. TCP connections are not supported.
-
-<HiddenFAQ
-  faqs={[
-    {
-      q: "How do I send logs from New Relic to Grepr for processing?",
-      a: "To send logs to Grepr before forwarding to New Relic, configure your collector to send logs to the Grepr ingestion URL instead of the New Relic endpoint. The ingestion URL format is https://<integration-id>-<org-id>.ingest.grepr.ai/nr/log/v1. You can use Fluent Bit or Fluentd collectors configured with the New Relic output plugin."
-    },
-    {
-      q: "What authentication credentials do I need for the New Relic integration?",
-      a: "You need a license key from your New Relic account for log ingestion. Optionally, to enable automatic exception parsing, you also need your New Relic Account ID and a user key. The user key must match the one your collectors use for authentication."
-    },
-    {
-      q: "How do I configure Fluent Bit to send logs to Grepr with a New Relic integration?",
-      a: "In your Fluent Bit configuration, create an OUTPUT section with Name set to 'newrelic', set the licenseKey to your New Relic license key, and set the endpoint to your Grepr ingestion URL. You can also configure multiple OUTPUT sections to dual-ship logs to both Grepr and New Relic directly."
-    },
-    {
-      q: "What is the automatic exception parsing feature for New Relic?",
-      a: "When you configure your New Relic integration with a user key and Account ID, Grepr automatically tracks dashboards and alerts in your New Relic account. Grepr parses the queries used in these dashboards and alerts and makes them available as exceptions to the Log Reducer, helping identify which messages should not be processed."
-    },
-    {
-      q: "How do I enable selective log reduction with New Relic?",
-      a: "Provide your New Relic Account ID and user key when creating the integration. Grepr will automatically sync with your New Relic dashboards and alerts. You can view the list of parsed exceptions by clicking the cloud sync icon under Actions on the Integrations page."
-    },
-    {
-      q: "How do I configure Fluentd to send logs to Grepr with a New Relic integration?",
-      a: "Add a match directive to your Fluentd configuration with @type set to 'newrelic', license_key set to your New Relic license key, and base_uri set to your Grepr ingestion URL. For dual-shipping, use the copy output plugin with multiple store sections for different destinations."
-    },
-    {
-      q: "Can I use New Relic integration to send processed logs back to New Relic?",
-      a: "Yes, you can add a sink to your Grepr pipeline that uses the New Relic integration. This allows logs to be ingested from New Relic sources, processed by Grepr pipelines, and then sent back to New Relic or other observability platforms."
-    },
-    {
-      q: "What is the advantage of using automatic exception parsing with New Relic?",
-      a: "Automatic exception parsing helps reduce log storage costs by identifying which log messages are tracked in your New Relic dashboards and alerts. The Log Reducer uses this information to avoid aggregating important messages while reducing redundant log volume, optimizing your observability costs."
-    },
-    {
-      q: "How often does Grepr sync with my New Relic dashboards and alerts?",
-      a: "You can specify how recently a dashboard must have been accessed to be included in automatic exception parsing. By default, Grepr checks for activity within the last 28 days, but you can adjust this setting when creating or updating your New Relic integration."
-    },
-    {
-      q: "Can I use the New Relic integration without the automatic exception parsing feature?",
-      a: "Yes, the automatic exception parsing feature is optional. You only need the license key to create and use a New Relic integration. The Account ID and user key are only required if you want to enable automatic exception parsing from your New Relic dashboards and alerts."
-    }
-  ]}
-/>

package/build/dist/docs-index/24a3675d-198b-413d-b9c6-c271099d174c.json

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

package/build/dist/docs-index/24a3675d-198b-413d-b9c6-c271099d174c.txt

@@ -1,8 +0,0 @@
-# ItemsCollectionReadOtlp
-
-**Type**: `object`
-
-## Properties
-
-- name: items (optional)
-  type: array of `ReadOtlp`

package/build/dist/docs-index/24c0059d-f6e8-43ed-a784-a078b74bc1ca.json

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

package/build/dist/docs-index/24c0059d-f6e8-43ed-a784-a078b74bc1ca.txt

@@ -1,17 +0,0 @@
-# UpdateRole
-
-**Type**: `object`
-
-## Properties
-
-- name: name (required)
-  type: string
-  description: The name of the role
-
-- name: description (required)
-  type: string
-  description: Description of the role
-
-- name: permissionIds (required)
-  type: array of string
-  description: Permission IDs to assign to this role

package/build/dist/docs-index/24c8cf34-2fa2-4cb6-92fb-d823845e6482.json

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

package/build/dist/docs-index/24c8cf34-2fa2-4cb6-92fb-d823845e6482.txt

@@ -1,104 +0,0 @@
----
-description: Process data in Grepr pipelines using built-in tools for parsing, filtering, enrichment, and transformation of log events.
----
-
-import { HiddenFAQ } from '@/components/HiddenFAQ'
-
-# Transform data in a Grepr pipeline
-
-A Grepr transform is a processing step that modifies, enriches, or restructures data as it flows through a pipeline. As records move through a pipeline, transforms allow you to parse structured and semi-structured data, filter records, and use a familiar SQL interface to perform more complex transformation of records as they move through a pipeline. Transforms are configured as pipeline steps that process data sequentially. Each transform receives input data, applies its logic, and passes the result to the next step in the pipeline.
-
-Most transforms are available in the Grepr pipelines UI. Some transforms are available only in the Grepr REST API or provide more capabilities when used with the API, such as [filters](#filter) and [branching the processing of records](#message-routing) based on query matches.
-
-The following sections describe the transforms available in Grepr pipelines.
-
-## Transform semi-structured records with the Grok parser [#grok-parser]
-
-The Grok transform parses unstructured text using pattern matching with regular expressions and named capture groups. Use this transform to extract fields from log lines, error messages, and other text-based data where you need to identify specific patterns and convert them to structured fields.
-
-See [Grok parser](/transforms/grok).
-
-## Convert JSON messages into structured objects [#json-parser]
-
-The JSON parser transforms JSON strings into structured JSON objects. This transform handles nested objects, arrays, and various data types, making it useful for processing API responses, configuration data, and structured log entries.
-
-See [Transform JSON strings into JSON objects](/transforms/json-parsing).
-
-## Restructure JSON objects with a remapper [#remapper]
-
-The remapper transform moves or copies attributes to top-level fields or to tags in a JSON object. In the pipelines UI, a remapper with customizable default attributes is automatically added to a pipeline.
-
-See [Remap JSON attribute fields to top-level log event fields](/transforms/remapper).
-
-## Transform records with SQL [#sql-transform]
-
-The SQL transform allows you to use ANSI standard SQL queries to filter, transform, and enrich data records. The SQL transform provides a familiar SQL interface to perform a number of data processing and transformation tasks.
-
-You can use the SQL transform in the Grepr UI or REST API. In the UI, the SQL transform is available when you configure filters.
-
-To learn about using the SQL transform in the Grepr API, see the [SQL Operation specification](/apis/api-spec#schema/SQLOperation).
-
-For a complete reference and examples, see [Transform events with SQL](/transforms/sql-transform).
-
-## Filter records based on conditions [#filter]
-
-The Filter transform includes or excludes data records based on specified conditions. You can create filters using familiar query interfaces, such as SQL, as well as Datadog, SPL, and New Relic-like query syntaxes.
-
-In the Grepr pipelines UI, filters are located in predefined locations in the pipeline. To learn how to configure filters, see [Filter events in a Grepr pipeline](/transforms/filter-events).
-
-To have more flexibility for where filters are included in a pipeline, use the REST API. See [LogsFilter](/apis/api-spec#schema/LogsFilter).
-
-## Transform and enrich log messages with the REST API
-
-You can use the LogTransformAction in the REST API to specify actions that transform log messages, such as adding or removing attributes and tags. See [LogTransformAction](/apis/api-spec#schema/LogTransformAction).
-
-## Route the processing of messages based on query matches [#message-routing]
-
-You can route log messages to be processed by different pipelines based on query matches. Because the pipelines UI doesn't support branching, Grepr recommends creating multiple pipelines that ingest data using the same source, and then use filters to route data to the correct pipeline.
-
-You can also use the REST API to create more complex pipeline configurations. See [LogsBranch](/apis/api-spec#schema/LogsBranch).
-
-<HiddenFAQ
-  faqs={[
-    {
-      q: "What transforms are available in Grepr pipelines?",
-      a: "Grepr provides several transform types: Grok parser for parsing unstructured text with pattern matching, JSON parser for converting JSON strings into structured objects, remapper for restructuring JSON fields and attributes, SQL transform for complex filtering and enrichment using SQL queries, and Filter transform for conditional record processing. Most transforms are available in the UI, while some advanced options are available via REST API."
-    },
-    {
-      q: "When should I use the Grok parser transform?",
-      a: "Use the Grok parser when you need to extract structured data from unstructured text logs. It's ideal for parsing error messages, application logs, system logs, and other text-based data where you need to identify specific patterns and convert them into structured fields using regular expressions and named capture groups."
-    },
-    {
-      q: "When should I use the JSON parser transform?",
-      a: "Use the JSON parser when your log messages contain JSON strings that need to be converted into structured JSON objects. This is useful for processing API responses, configuration data, and structured log entries. The JSON parser handles nested objects, arrays, and various data types automatically."
-    },
-    {
-      q: "What is the remapper transform and when is it used?",
-      a: "The remapper transform moves or copies attributes to top-level fields or to tags in a JSON object. It's useful for standardizing log event structure by moving well-known fields like message, severity, and host from nested attributes to top-level fields. The remapper is automatically added to pipelines in the UI with customizable default attributes."
-    },
-    {
-      q: "When should I use the SQL transform?",
-      a: "Use the SQL transform when you need complex filtering, transformation, or enrichment of log records. SQL provides a familiar interface for advanced operations like conditional logic, string manipulation, aggregations, and joining data. It's available in the UI for filters and via REST API for more flexibility."
-    },
-    {
-      q: "Can I combine multiple transforms in a pipeline?",
-      a: "Yes, transforms are configured as sequential pipeline steps. Each transform receives input from the previous step, applies its logic, and passes the result to the next step. This allows you to create complex data processing workflows by combining parsing (Grok), restructuring (remapper), and filtering/enrichment (SQL) transforms."
-    },
-    {
-      q: "What is the Filter transform used for?",
-      a: "The Filter transform includes or excludes data records based on specified conditions. You can use filters with SQL, Datadog, SPL, and New Relic-like query syntaxes. In the UI, filters are located in predefined pipeline positions, while the REST API provides more flexibility for filter placement."
-    },
-    {
-      q: "Can I use the REST API for more advanced transform options?",
-      a: "Yes, the REST API provides access to advanced transform options not available in the UI. For example, you can use LogTransformAction to add or remove attributes and tags, LogsBranch for complex message routing based on query matches, and more flexible filter placement. See the API specification for complete details on transform capabilities."
-    },
-    {
-      q: "How do I choose between Grok and SQL transforms?",
-      a: "Use Grok when you need pattern-based parsing of unstructured text to extract specific fields. Use SQL when you need complex conditional logic, calculations, string transformations, or filtering. Grok is specialized for text parsing, while SQL is more general-purpose for data manipulation and enrichment."
-    },
-    {
-      q: "What happens if a transform fails on a record?",
-      a: "Transform behavior depends on the specific transform type and configuration. Parsing errors (like Grok or JSON parsing) typically skip records or add error attributes depending on your configuration. SQL transforms filter out records that don't match conditions. Review transform-specific documentation for error handling details."
-    }
-  ]}
-/>

package/build/dist/docs-index/26109a68-60c9-4b95-808e-64fbbd692b27.json

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

package/build/dist/docs-index/26109a68-60c9-4b95-808e-64fbbd692b27.txt

@@ -1,24 +0,0 @@
-# WriteDataWarehouse
-
-**Type**: `object`
-
-## Properties
-
-- name: name (required)
-  type: string
-  description: Name of the integration.
-
-- name: version (required)
-  type: integer
-  description: Version of the integration. Should be increased by one for every new update in order for the write to succeed. Otherwise, a '409 Conflict' will be returned.
-
-- name: payload (required)
-  type: `DataWarehouse`
-
-- name: teamIds (optional)
-  type: array of string
-  description: The team IDs that this integration is associated with.
-
-- name: type (required)
-  type: enum: `data-warehouse`
-  description: The type of the integration. This is used to determine the payload type.

package/build/dist/docs-index/26262142-3627-4105-8e51-2f0ea704f4bc.json

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

package/build/dist/docs-index/26262142-3627-4105-8e51-2f0ea704f4bc.txt

@@ -1,15 +0,0 @@
-# DatasetCreate
-
-**Type**: `object`
-
-## Properties
-
-- name: name (required)
-  type: string
-
-- name: integrationId (required)
-  type: string
-
-- name: teamIds (optional)
-  type: array of string
-  description: The team IDs that this dataset is associated with.

package/build/dist/docs-index/26ca007a-9a83-4194-98eb-ca573823803f.json

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

package/build/dist/docs-index/26ca007a-9a83-4194-98eb-ca573823803f.txt

@@ -1,29 +0,0 @@
-# Get a SumoLogic integration
-
-**GET** `/v1/integrations/sumo/{id}`
-
-**Operation ID**: `get_6`
-**Summary**: Get a SumoLogic integration
-Get an integration to connect to SumoLogic.
-
-## Tags
-- Sumo Logic Integration
-## Parameters
-
-- **id** (required) - path
-  - Type: string
-
-## Responses
-
-### 200
-
-Integration retrieved successfully
-
-- **Content-Type**: `application/json` / `ReadSumo`
-### 401
-
-Unauthorized
-
-### 404
-
-Integration not found.

package/build/dist/docs-index/270940ac-4cbe-4785-8716-3f3a6ae60a93.json

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

package/build/dist/docs-index/270940ac-4cbe-4785-8716-3f3a6ae60a93.txt

@@ -1,81 +0,0 @@
-# Span
-
-A distributed tracing span.
-
-**Type**: `object`
-
-## Properties
-
-- name: traceIdHigh (optional)
-  type: integer
-  description: High 8 bytes of 16-byte trace identifier.
-
-- name: traceIdLow (optional)
-  type: integer
-  description: Low 8 bytes of 16-byte trace identifier.
-
-- name: spanId (optional)
-  type: integer
-  description: 8-byte span identifier as long.
-
-- name: droppedAttributesCount (optional)
-  type: integer
-  description: Number of attributes that were dropped due to limits.
-
-- name: parentSpanId (optional)
-  type: integer
-  description: 8-byte parent span identifier as long. Returns 0 for root spans.
-
-- name: durationNanos (optional)
-  type: integer
-  description: Calculated duration in nanoseconds.
-
-- name: spanKind (optional)
-  type: enum: `UNSPECIFIED`, `INTERNAL`, `SERVER`, `CLIENT`, `PRODUCER`, `CONSUMER`
-  description: The type of span
-
-- name: traceState (optional)
-  type: string
-  description: Trace state information in W3C format.
-
-- name: endTimeNanos (optional)
-  type: integer
-  description: End timestamp in nanoseconds since epoch.
-
-- name: startTimeNanos (optional)
-  type: integer
-  description: Start timestamp in nanoseconds since epoch.
-
-- name: droppedEventsCount (optional)
-  type: integer
-  description: Number of events that were dropped due to limits.
-
-- name: droppedLinksCount (optional)
-  type: integer
-  description: Number of links that were dropped due to limits.
-
-- name: links (optional)
-  type: array of `SpanLink`
-  description: List of links to other spans.
-
-- name: operationName (optional)
-  type: string
-  description: Human-readable span name describing the operation.
-
-- name: attributes (optional)
-  type: `Variant`
-
-- name: root (optional)
-  type: boolean
-  description: True if this is a root span (no parent).
-
-- name: flags (optional)
-  type: integer
-  description: Span flags as defined in W3C Trace Context specification.
-
-- name: status (optional)
-  type: `Status`
-
-- name: events (optional)
-  type: array of `SpanEvent`
-  description: List of events associated with this span.

package/build/dist/docs-index/274a4f45-d529-4471-9a80-cb4f3f712c74.json

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