@grepr/cli 1.2.0 → 1.3.0-94fe60c

package/build/dist/docs-index/80fa0f2a-b4e3-434a-9dea-3d54d9c831f8.txt

@@ -1,141 +0,0 @@
----
-description: Get an overview of the Grepr platform core components that support real-time processing and analysis of logs, reducing log volumes, and long-term storage of raw logs.
----
-
-import { HiddenFAQ } from '@/components/HiddenFAQ'
-
-# Overview of the Grepr Platform
-
-The Grepr platform enables efficient collection, storage, processing, and analysis of log data. Because Grepr is built on a general-purpose stream processing engine, you can create processing pipelines for your logs using standard observability pipeline capabilities such as filtering, parsing, transforming, and routing of processed logs. The Grepr log processing functionality optimizes logs shipped to observability platforms, reducing log volume and observability costs.
-
-This page provides an overview of the Grepr platform's core components and how to access its features. This page also has an overview of how the platform handles security, high availability, and scalability. Links to more detailed documentation for each topic are included.
-
-The Grepr platform uses a software as a service (SaaS) model. For larger deployments or for customers with strict compliance requirements, Grepr also offers a private cloud deployment model. Grepr runs in AWS for both models.
-
-## Reducing log volumes with dynamic aggregation
-
-Grepr uses machine learning to identify patterns in your log data and aggregate similar log messages. The output of this aggregation includes summaries and samples of similar messages, which are then forwarded to your observability platform. By sending summaries of similar messages instead of multiple events with redundant information, Grepr significantly reduces the volume of the shipped logs and your observability costs, while retaining the ability to analyze and troubleshoot issues effectively. Grepr retains the original raw logs in a low-cost data lake, allowing you to access the full logs for troubleshooting and analysis.
-
-This aggregation occurs automatically and requires no configuration. When you need to modify the default aggregation, several configuration options are available to tune the aggregation behavior based on your requirements.
-
-When an incident occurs or alerts are raised in your infrastructure, Grepr can automatically ensure that you have a complete set of logs to debug the issue. Grepr does this by temporarily increasing the granularity of related logs forwarded to your observability platform and by backfilling relevant logs from the raw data store. This capability can be triggered manually or automatically in response to monitoring alerts or specific log data matches.
-
-To learn more about how Grepr reduces log volumes with dynamic aggregation, see [Optimizing logs with Grepr's intelligent aggregation](/grepr-platform/reduction).
-
-To learn how to use summarized logs in your observability platform along with raw logs stored in Grepr, see [Troubleshoot incidents with Grepr-processed data and your observability tool](/tutorials/troubleshooting-example).
-
-## Understanding the Grepr processing and data models
-
-Grepr uses a flexible processing model that allows you to build complex log-processing pipelines and run queries. The processing model supports standard observability pipeline capabilities, including filtering, parsing, transforming, and routing of processed logs. Grepr also uses a standardized data model for processed log events that represents log data as records with fields and attributes. This data model enables efficient processing and querying of log data.
-
-See [The Grepr processing and data models](/grepr-platform/grepr-model).
-
-## Raw data storage in the Grepr data lake
-
-The Grepr data lake uses Amazon S3 for low-cost object storage of your full raw logs. You can use an S3 bucket provided by Grepr or a bucket in your own account. Logs are stored using Apache Parquet files and the Apache Iceberg table format, providing efficient storage and querying of the logs. To query logs stored in the data lake, the Data Explorer in the Grepr UI provides a user-friendly, visual interface.
-
-To learn more about the data lake, see [The Grepr data lake](/grepr-platform/data-lake).
-
-To learn more about querying log data in the data lake, see [Query log data in the Grepr data lake](/queries).
-
-For programmatic access, the Grepr CLI and REST API also support functionality for querying logs in the data lake. See [The Grepr CLI](/cli) and [Automate Grepr processing with the Grepr REST APIs](/apis).
-
-## Security in the Grepr platform
-
-The Grepr platform offers comprehensive security and compliance features to safeguard your data and fulfill enterprise security requirements. These features include secure authentication and identity management with OAuth 2.0, SOC 2 Type 2 compliance, HIPAA compliance, infrastructure and networking security, and data encryption.
-
-See [Security in the Grepr platform](/grepr-platform/security).
-
-## High availability and scalability
-
-The Grepr platform is designed for high availability, ensuring minimal downtime for your log processing pipelines. The platform is also designed for scalability, automatically adding and removing capacity as needed to match processing loads.
-
-See [How does Grepr ensure high availability?](/grepr-platform/high-availability).
-
-## Accessing Grepr functionality
-
-Grepr offers three primary access methods to interact with the platform's capabilities: a web-based user interface (UI), a comprehensive set of RESTful APIs, and a command-line interface (CLI). You can use any combination of these access methods based on your requirements and preferences.
-
-### The Grepr web-based user interface (UI)
-
-The Grepr UI provides:
-
-- A streamlined, task-oriented experience for creating and managing pipelines.
-- Visual tools for searching and exploring log data.
-- Dashboards that visualize pipeline performance and data flows.
-- Guided workflows for common observability tasks.
-
-### The Grepr REST API
-
-To access some advanced features and automate tasks, the REST API provides:
-
-- Complete programmatic control over all Grepr capabilities.
-- The ability to integrate Grepr into your existing workflows and tools.
-- Customization options for complex observability pipelines.
-- Support for infrastructure-as-code and GitOps approaches.
-
-See [Automate Grepr processing with the Grepr REST APIs](/apis).
-
-### The Grepr command-line interface (CLI)
-
-The Grepr CLI allows you to manage jobs and run queries in the Grepr platform from the command line. You can also use the CLI in your scripts or other clients to automate tasks.
-
-See [The Grepr CLI](/cli).
-
-### The Grepr Terraform provider
-
-The Grepr Terraform provider enables infrastructure as code management of Grepr pipelines. With the Terraform provider, you can:
-
-- Define pipelines as code in your version control system.
-- Automate pipeline deployment as part of your CI/CD workflows.
-- Manage multiple environments, such as development, staging, and production, with consistent configurations.
-- Track changes to pipeline configurations over time.
-
-See [The Grepr Terraform provider](/grepr-platform/terraform-provider).
-
-<HiddenFAQ faqs={[
-  {
-    q: "What is the Grepr platform?",
-    a: "Grepr is a dynamic observability engine that enables efficient collection, storage, processing, and analysis of log data. It uses stream processing to create pipelines with capabilities such as filtering, parsing, transforming, and routing logs. Grepr is available as a SaaS model in AWS and as a private cloud deployment for larger organizations with compliance requirements."
-  },
-  {
-    q: "How does Grepr reduce log volumes and observability costs?",
-    a: "Grepr uses machine learning to identify patterns in log data and aggregates similar log messages. Instead of sending multiple redundant log events, Grepr sends summaries and samples of similar messages to your observability platform. This significantly reduces the volume of shipped logs while retaining the ability to analyze and troubleshoot issues. Raw logs are retained in a low-cost data lake for future reference."
-  },
-  {
-    q: "What happens during an incident or alert with Grepr?",
-    a: "When an incident occurs or alerts are raised, Grepr can automatically ensure you have complete logs for debugging. It does this by temporarily increasing the granularity of related logs forwarded to your observability platform and by backfilling relevant logs from the raw data store. This capability can be triggered manually or automatically in response to monitoring alerts or specific log data matches."
-  },
-  {
-    q: "Where are my raw logs stored in Grepr?",
-    a: "Raw logs are stored in the Grepr data lake, which uses Amazon S3 for low-cost object storage. You can choose to use an S3 bucket provided by Grepr or a bucket in your own AWS account. Logs are stored using Apache Parquet files and the Apache Iceberg table format, providing efficient storage and querying."
-  },
-  {
-    q: "How do I interact with the Grepr platform?",
-    a: "You can interact with Grepr through three primary methods: the web-based UI for visual pipeline creation and log exploration, the REST API for programmatic control and automation, and the CLI for command-line management of jobs and queries. These can be used individually or in combination based on your needs."
-  },
-  {
-    q: "What security features does Grepr provide?",
-    a: "Grepr offers comprehensive security features including secure OAuth 2.0 authentication and identity management, SOC 2 Type 2 compliance, HIPAA compliance, infrastructure and networking security, and data encryption. These features safeguard your data and fulfill enterprise security requirements."
-  },
-  {
-    q: "How does Grepr ensure high availability?",
-    a: "Grepr is designed for high availability with minimal downtime for log processing pipelines. It runs on AWS with compute nodes deployed across three availability zones. Stateless services run on multiple replicas across zones with automatic scaling, and data pipelines are stateful with automatic failover and recovery from checkpoints."
-  },
-  {
-    q: "Can Grepr automatically scale to handle increased log volume?",
-    a: "Yes, the Grepr platform is designed for scalability. It automatically adds and removes capacity as needed to match processing loads. Streaming jobs automatically scale up and down, and batch jobs automatically execute at optimal parallelism levels to reduce latency without sacrificing efficiency."
-  },
-  {
-    q: "What is a Grepr pipeline?",
-    a: "A Grepr pipeline is an asynchronous, continuously-running job that ingests data from a source, processes it through transformations, and delivers it to one or more sinks. Pipelines are configured to run until stopped, allowing you to continuously collect, process, and forward log data based on your observability requirements."
-  },
-  {
-    q: "How do I get started with Grepr?",
-    a: "To get started, you need to understand the Grepr data model and processing concepts, configure integrations with your observability platforms and cloud storage, and create pipelines using the UI or APIs. You can also query logs stored in the data lake using the Data Explorer or programmatically via the CLI or REST API."
-  },
-  {
-    q: "How do I manage Grepr deployments and pipelines using IaS or Infrastructure as Code?",
-    a: "Grepr has an open-source Terraform provider that you can use to manage pipelines via git workflows and using infrastructure-as-code."
-  }
-]} />

package/build/dist/docs-index/8112f4eb-ca7c-428b-bcc0-ce14ab2fbbb6.json

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

package/build/dist/docs-index/8112f4eb-ca7c-428b-bcc0-ce14ab2fbbb6.txt

@@ -1,24 +0,0 @@
-# WriteNewRelic
-
-**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: `NewRelic`
-
-- name: teamIds (optional)
-  type: array of string
-  description: The team IDs that this integration is associated with.
-
-- name: type (required)
-  type: enum: `newrelic`
-  description: The type of the integration. This is used to determine the payload type.

package/build/dist/docs-index/815d30f5-f871-4bf4-bab5-de6a333e6830.json

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

package/build/dist/docs-index/815d30f5-f871-4bf4-bab5-de6a333e6830.txt

@@ -1,43 +0,0 @@
-# LogsIcebergTableSource
-
-**Type**: `object`
-
-## Properties
-
-- name: name (required)
-  type: string
-
-- name: start (required)
-  type: string
-  description: Start of time interval to query data for.
-
-- name: end (required)
-  type: string
-  description: End of time interval to query data for.
-
-- name: query (required)
-  type: `query`
-
-- name: variables (optional)
-  type: object
-  description: Variables that can be used to modify the query while parsed
-
-- name: offset (optional)
-  type: integer
-  description: Offset on the number of rows to process
-
-- name: limit (optional)
-  type: integer
-  description: The maximum number of rows to process
-
-- name: sortOrder (optional)
-  type: enum: `ASCENDING`, `DESCENDING`, `UNSORTED`
-  description: The order in which the rows should be sorted by
-
-- name: datasetId (required)
-  type: string
-  description: The ID of the dataset to read data from.
-
-- name: type (required)
-  type: enum: `logs-iceberg-table-source`
-  description: Reads events from an Iceberg table for processing.

package/build/dist/docs-index/819213c7-eae0-41eb-86c0-589b76b1ef7a.json

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

package/build/dist/docs-index/819213c7-eae0-41eb-86c0-589b76b1ef7a.txt

@@ -1,8 +0,0 @@
-# SocialUserInfo
-
-**Type**: `object`
-
-## Properties
-
-- name: idToken (required)
-  type: string

package/build/dist/docs-index/81bf0756-3027-40be-a7d4-6d628950e248.json

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

package/build/dist/docs-index/81bf0756-3027-40be-a7d4-6d628950e248.txt

@@ -1,16 +0,0 @@
-# Invitee
-
-**Type**: `object`
-
-## Properties
-
-- name: email (optional)
-  type: string
-
-- name: teamAssignments (optional)
-  type: array of `TeamAssignment`
-  description: Team-specific role assignments
-
-- name: roleIds (optional)
-  type: array of string
-  description: Role IDs assigned to the invitation

package/build/dist/docs-index/831df24c-448f-4cf1-9a81-662f3b5b6fa2.json

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

package/build/dist/docs-index/831df24c-448f-4cf1-9a81-662f3b5b6fa2.txt

@@ -1,40 +0,0 @@
-# IntegrationExceptionImpactEstimationConfig
-
-**Type**: `object`
-
-## Properties
-
-- name: datasetId (required)
-  type: string
-  description: ID of the dataset that contains raw data to be queried to calculate how many logs match exceptions loaded by a vendor integration.
-
-- name: query (optional)
-  type: `EventPredicate`
-
-- name: lookbackDuration (optional)
-  type: string
-  description: Lookback duration for which to calculate exception impact. Uses ISO-8601 duration format.
-
-- name: logLimit (optional)
-  type: integer
-  description: Maximum number of log messages to match.
-
-- name: refreshPeriod (optional)
-  type: string
-  description: How often to refresh exception impact percentages. Uses ISO-8601 duration format.
-
-- name: organizationId (optional)
-  type: string
-  description: Organization ID
-
-- name: integrationId (optional)
-  type: string
-  description: Integration ID
-
-- name: createdAt (optional)
-  type: string
-  description: Creation timestamp
-
-- name: updatedAt (optional)
-  type: string
-  description: Last update timestamp

package/build/dist/docs-index/83954f71-e89e-41ed-9089-5f85ef2eda5d.json

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

package/build/dist/docs-index/83954f71-e89e-41ed-9089-5f85ef2eda5d.txt

@@ -1,20 +0,0 @@
-# DatadogLogCloudSource
-
-**Type**: `object`
-
-## Properties
-
-- name: name (required)
-  type: string
-
-- name: integrationId (required)
-  type: string
-  description: The Datadog integration id.
-
-- name: filterQuery (optional)
-  type: string
-  description: The Datadog query filter to use when reading logs from Datadog. This is concatenated with the one from the integration.
-
-- name: type (required)
-  type: enum: `datadog-log-cloud-source`
-  description: Pulls log events from the Datadog cloud service for processing using a specified query.

package/build/dist/docs-index/8447ffa6-5a60-4607-8cc1-cddc58b7a0b2.json

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

package/build/dist/docs-index/8447ffa6-5a60-4607-8cc1-cddc58b7a0b2.txt

@@ -1,14 +0,0 @@
-# BucketAccessResult
-
-**Type**: `object`
-
-## Properties
-
-- name: accessible (optional)
-  type: boolean
-
-- name: message (optional)
-  type: string
-
-- name: retryable (optional)
-  type: boolean

package/build/dist/docs-index/84b365c4-93c8-4a50-b98d-35442b6d7a3e.json

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

package/build/dist/docs-index/84b365c4-93c8-4a50-b98d-35442b6d7a3e.txt

@@ -1,12 +0,0 @@
-When you have teams in your Grepr organization, you can optionally grant access to the {props.resource_type || 'resource'} to one or more of those teams. To configure team access when you create an integration:
-
-1. In the **Grant Team Access** card, click the plus sign icon (+).
-1. Select the team or teams that should be granted access to the integration.
-1. Click **Create**.
-
-   ![The Grant Team Access to a resource card in the Grepr UI.](/images/shared/add-team-access-to-integration.png)
-
-   You can also add or remove teams when you edit the integration.
-
-   To learn more, see [Manage teams in the Grepr platform](/admin/manage-teams) and [Permissions in the Grepr platform](/grepr-platform/permissions).
-

package/build/dist/docs-index/84dd297d-32d6-439a-9ad2-06d104c79549.json

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

package/build/dist/docs-index/84dd297d-32d6-439a-9ad2-06d104c79549.txt

@@ -1,9 +0,0 @@
-To send data to Grepr, you configure your collector or agent to send the data to the ingestion URL for your Grepr integration, rather than sending it to your observability vendor's platform. To find the ingestion URL when using the Grepr UI to configure your pipeline, go to the details view for the pipeline, click **Sources** in the left pane, and copy the **Ingest URL**.
-
-<br /><img src={props.image_url || '/images/integrations/ingest-url-datadog.png'} alt="Accessing the Grepr ingestion URL in the UI." />
-
-When you use the API, you can construct the ingestion URL using the following format:
-
-<br /><code className="nextra-code"> {props.url || 'https://<integration-id>-<org-id>.ingest.grepr.ai'}</ code>
-
-Replace `<integration-id>` with the identifier of the vendor integration used by your pipeline and replace `<org-id>` with the identifier for your organization.

package/build/dist/docs-index/859d7f83-069d-4b01-a67f-4d5b51d18211.json

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

package/build/dist/docs-index/859d7f83-069d-4b01-a67f-4d5b51d18211.txt

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

package/build/dist/docs-index/85cd2816-029c-460f-b8c9-d2a296b544cb.json

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

package/build/dist/docs-index/85cd2816-029c-460f-b8c9-d2a296b544cb.txt

@@ -1,29 +0,0 @@
-# Get available roles for a team
-
-**GET** `/v1/teams/{id}/roles`
-
-**Operation ID**: `getTeamRoles`
-**Summary**: Get available roles for a team
-Returns the leader and member roles available for assignment in this team
-
-## Tags
-- Teams
-## Parameters
-
-- **id** (required) - path
-  - Type: string
-
-## Responses
-
-### 200
-
-Team roles retrieved successfully
-
-- **Content-Type**: `application/json` / array of `Role`
-### 401
-
-Unauthorized
-
-### 404
-
-Not Found

package/build/dist/docs-index/86c35409-bf4a-4407-b418-fc79f75ebba6.json

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

package/build/dist/docs-index/86c35409-bf4a-4407-b418-fc79f75ebba6.txt

@@ -1,13 +0,0 @@
-# SplQueryPredicate
-
-**Type**: `object`
-
-## Properties
-
-- name: query (required)
-  type: string
-  description: The spl query used by the predicate. See https://docs.splunk.com/Documentation/SplunkCloud/9.3.2408/SearchReference
-
-- name: type (required)
-  type: enum: `spl-query`
-  description: A predicate that checks if an event matches an SPL query.

package/build/dist/docs-index/86dae0bb-a3e4-4e66-b3f2-0174ec6b8085.json

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

package/build/dist/docs-index/86dae0bb-a3e4-4e66-b3f2-0174ec6b8085.txt

@@ -1,36 +0,0 @@
-# Runs a template script and returns the result.
-
-**POST** `/v1/templates/test`
-
-**Operation ID**: `testTemplate`
-**Summary**: Runs a template script and returns the result.
-Runs a template script and returns the result. The result should be deserializable to a GreprJobGraph if the 'testDeserialization' parameter is true in the payload.
-
-## Tags
-- Templates
-## Request Body
-
-Template and input values for the template.
-
-**Content-Type**: `application/json`
-
-**Schema**: `TemplateAndInputs`
-
-## Responses
-
-### 200
-
-Job graph generated successfully
-
-- **Content-Type**: `application/json` / `GreprJobGraph`
-### 400
-
-Invalid input
-
-### 401
-
-Unauthorized
-
-### 429
-
-Code generation limit exceeded for bad code. This can happen if the template runs too long or uses too many resources. The organization will be throttled for executing too many bad code generations.

package/build/dist/docs-index/87a8a51c-e216-4361-935c-219fd485240a.json

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

package/build/dist/docs-index/87a8a51c-e216-4361-935c-219fd485240a.txt

@@ -1,36 +0,0 @@
-# Get a job
-
-**GET** `/v1/jobs/{id}`
-
-**Operation ID**: `getJob`
-**Summary**: Get a job
-Gets a job with the given id. If version is not specified, the latest version is returned, otherwise, the job with the specified version is returned. If the job has templates, the 'resolved' query parameter can be used to resolve templates and return the fully resolved job.
-
-## Tags
-- Jobs
-## Parameters
-
-- **id** (required) - path
-  - Id of the job to retrieve
-  - Type: string
-- **version** (optional) - query
-  - Version of the job to retrieve
-  - Type: integer
-- **resolved** (optional) - query
-  - If set to true, the job will be resolved into a subgraph with all templates resolved. If false, the job will be returned as is.
-  - Type: boolean
-
-## Responses
-
-### 200
-
-Job retrieved successfully
-
-- **Content-Type**: `application/json` / `ReadJob`
-### 401
-
-Unauthorized
-
-### 404
-
-Job not found.

package/build/dist/docs-index/8803d699-dcae-4b3f-872e-3cabe0311a24.json

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

package/build/dist/docs-index/8803d699-dcae-4b3f-872e-3cabe0311a24.txt

@@ -1,34 +0,0 @@
-# Create a new custom role
-
-**POST** `/v1/roles`
-
-**Operation ID**: `createRole`
-**Summary**: Create a new custom role
-Creates a new custom role with specified permissions
-
-## Tags
-- Roles
-## Request Body
-
-**Content-Type**: `application/json`
-
-**Schema**: `CreateRole`
-
-## Responses
-
-### 201
-
-Role created successfully
-
-- **Content-Type**: `application/json` / `Role`
-### 400
-
-Invalid request data
-
-### 403
-
-Insufficient permissions
-
-### 409
-
-Role name already exists

package/build/dist/docs-index/888ff512-d899-4e4b-9da9-938c6eff1b83.json

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

package/build/dist/docs-index/888ff512-d899-4e4b-9da9-938c6eff1b83.txt

@@ -1,21 +0,0 @@
-# MergeMapAttributeAction
-
-**Type**: `object`
-
-## Properties
-
-- name: order (optional)
-  type: integer
-  description: Action order. Lower is applied first.
-
-- name: targetPath (required)
-  type: string
-  description: The path to the attribute to merge into.
-
-- name: value (required)
-  type: object
-  description: The value to merge.
-
-- name: type (required)
-  type: enum: `attribute-merge-action`
-  description: Merge value into a map in a event attributes. If the target map is not present or the target is not a map, it is a no-op. If values for the keys already exist, they are overwritten.

package/build/dist/docs-index/88a04369-40da-4fed-a6ec-509a5dc24656.json

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