@grepr/cli 1.2.0 → 1.3.0-4e666db

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

@@ -1,137 +0,0 @@
----
-description: Learn how to authenticate against the Grepr REST APIs.
----
-
-import { Callout } from 'nextra/components'
-import { HiddenFAQ } from '@/components/HiddenFAQ'
-
-# Authenticate to Grepr REST APIs
-
-By default, most endpoints in the Grepr REST APIs are restricted and cannot be accessed until enabled. To enable access, you must have credentials provided by the Grepr support team. You then use these credentials to obtain an access token for API authentication.
-
-To obtain the required credentials, contact [support@grepr.ai](mailto:support@grepr.ai). The support team will send the following credentials:
-
-- **client ID**: A unique identifier for your organization.
-- **client secret**: A secret key to authenticate your organization.
-
-The exception to the access restrictions for the Grepr APIs is the `POST /v1/triggers` endpoint to create external triggers.
-
-## Obtain an access token for Grepr REST APIs
-
-Grepr uses [Auth0](https://auth0.com/) as the identity provider for authentication. To obtain an access token to use with Grepr APIs, you send a request to the `token` endpoint:
-
-`POST https://grepr-prod.us.auth0.com/oauth/token` endpoint.
-
-The following example submits a token request using the `curl` command. `client_id` and `client_secret` are the credential values provided by Grepr support:
-
-```bash copy
-curl --url https://grepr-prod.us.auth0.com/oauth/token \
---header 'content-type: application/json' \
---data '{
-  "client_id": "<client_id>",
-  "client_secret": "<client_secret>",
-  "audience": "service",
-  "grant_type": "client_credentials"
-}'
-```
-
-Example response:
-
-```json
-{
-    "access_token": "<access_token>",
-    "token_type": "Bearer",
-    "expires_in": "86400",
-    "scope": "service"
-}
-```
-
-<Callout type="info">
-  - The access token has access to all APIs that Grepr provides to its customers. However, if you need to restrict access to specific APIs, you can reduce the access scope of a token. For help, contact [support@grepr.ai](mailto:support@grepr.ai).
-  - The access token has a limited lifetime of 86400 seconds, which is equivalent to 24 hours. You must obtain a new token when it expires.
-  - Keep the credentials you receive and the auth token secure. To prevent unauthorized access, do not expose these values in your client-side code or commit them to a version control repository.
-</Callout>
-
-## Use the access token with the Grepr API
-
-To authenticate against the Grepr APIs, include the access token as a `Bearer` token in the `Authorization` header of all API requests. If you submit a request using an expired token, a `401 Unauthorized` response is returned, and you must obtain a new access token.
-
-The following example uses the `curl` command to get all `Asynchronous` `Streaming` jobs from the `jobs` endpoint.
-
-```bash copy
-curl "https://<your_org_id>.app.grepr.ai/api/v1/jobs?processing=STREAMING&execution=ASYNCHRONOUS" \
--H "Content-Type: application/json" \
--H "Authorization: Bearer <your_access_token>"
-```
-
-Example response:
-
-```json
-{
-  "items": [
-    {
-      "id": "0ABC123DEF456",
-      "name": "Demo Job",
-      "version": 0,
-      "organizationId": "grepr",
-      "execution": "ASYNCHRONOUS",
-      "processing": "STREAMING",
-      "state": "RUNNING",
-      "desiredState": "RUNNING",
-      "jobGraph": {
-        "vertices": [],
-        "edges": []
-      },
-      "createdAt": "2021-09-01T00:00:00Z",
-      "updatedAt": "2021-09-01T00:00:00Z",
-      "tags": {
-        "createdUsing": "API",
-        "createdByUser": "Hardworking Beaver"
-      }
-    }
-  ]
-}
-```
-
-<HiddenFAQ faqs={[
-  {
-    q: "How do I authenticate to the Grepr REST API?",
-    a: "You authenticate using OAuth 2.0 with Auth0. Obtain a client_id and client_secret from Grepr support, then exchange them for an access token. Include the token as a Bearer token in the Authorization header of API requests."
-  },
-  {
-    q: "How do I get API credentials?",
-    a: "Contact the Grepr support team at support@grepr.ai. They will provide you with a client_id (unique identifier for your organization) and client_secret (secret key for authentication)."
-  },
-  {
-    q: "What is the token endpoint URL?",
-    a: "The token endpoint for obtaining access tokens is: POST https://grepr-prod.us.auth0.com/oauth/token"
-  },
-  {
-    q: "How long are access tokens valid?",
-    a: "Access tokens are valid for 86400 seconds, which is equivalent to 24 hours. You must obtain a new token when it expires."
-  },
-  {
-    q: "What is the correct format for the Authorization header?",
-    a: "Include the access token as a Bearer token in the Authorization header: Authorization: Bearer <your_access_token>"
-  },
-  {
-    q: "What grant type should I use for API authentication?",
-    a: "Use the client_credentials grant type for API authentication. This is the standard grant type for server-to-server authentication."
-  },
-  {
-    q: "What is the audience parameter in the token request?",
-    a: "The audience parameter in token requests should be set to 'service' to authenticate against the Grepr APIs."
-  },
-  {
-    q: "Can I restrict the scope of an access token?",
-    a: "Yes, you can reduce the access scope of a token to restrict it to specific APIs. Contact support@grepr.ai for help configuring token scopes."
-  },
-  {
-    q: "What happens if I use an expired token?",
-    a: "If you submit a request with an expired token, the API returns a 401 Unauthorized response. You must obtain a new access token and retry the request."
-  },
-  {
-    q: "Where should I store API credentials?",
-    a: "Never expose API credentials in client-side code or commit them to version control. Store them securely in environment variables, secret management systems, or secure configuration files with restricted access."
-  }
-]} />

package/build/dist/docs-index/88ef5fff-9c36-4eae-bdf8-7fe018f2035f.json

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

package/build/dist/docs-index/88ef5fff-9c36-4eae-bdf8-7fe018f2035f.txt

@@ -1,30 +0,0 @@
-# CreateJob
-
-Attributes of the Grepr Job to create
-
-**Type**: `object`
-
-## Properties
-
-- name: name (required)
-  type: string
-  description: Name of the job
-
-- name: execution (required)
-  type: enum: `SYNCHRONOUS`, `ASYNCHRONOUS`
-  description: Execution mode of the job
-
-- name: processing (required)
-  type: enum: `BATCH`, `STREAMING`
-  description: Processing method of the job
-
-- name: jobGraph (required)
-  type: `GreprJobGraph`
-
-- name: tags (optional)
-  type: object
-  description: Custom tags added to the job for ease of search
-
-- name: teamIds (optional)
-  type: array of string
-  description: The team IDs that this job is associated with.

package/build/dist/docs-index/8b2576f7-b62e-4f32-a175-4e200d26e6af.json

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

package/build/dist/docs-index/8b2576f7-b62e-4f32-a175-4e200d26e6af.txt

@@ -1,23 +0,0 @@
-# ReadableData
-
-Readable data via a synchronous job.
-
-**Type**: `object`
-
-## One Of
-
-This schema accepts one of the following types:
-
-### Option 1
-`LogEvent`
-
-### Option 2
-`DoubleDatapoint`
-
-### Option 3
-`CompleteSpan`
-
-## Properties
-
-- name: type (required)
-  type: string

package/build/dist/docs-index/8b5f4a71-d772-4700-95b7-96db74963045.json

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

package/build/dist/docs-index/8b5f4a71-d772-4700-95b7-96db74963045.txt

@@ -1,23 +0,0 @@
-# ExternalTriggerPayload
-
-Payload that define attributes that will fire an external source trigger.
-
-**Type**: `object`
-
-## Properties
-
-- name: triggerId (required)
-  type: string
-  description: ID of the external source trigger that should be triggered. This must exist in the Logs Rule Engine configuration of the corresponding job
-
-- name: jobId (required)
-  type: string
-  description: ID of the job that the trigger is meant for.
-
-- name: logsRuleEngineName (required)
-  type: string
-  description: Name of the rule engine that will process the trigger. This must exist in the corresponding Grepr job graph.
-
-- name: variables (optional)
-  type: object
-  description: Variables needed by the conditions that get activated when the corresponding triggers gets fired. 

package/build/dist/docs-index/8b604d13-c7ec-4e7e-bebc-5b1a666d75ca.json

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

package/build/dist/docs-index/8b604d13-c7ec-4e7e-bebc-5b1a666d75ca.txt

@@ -1,31 +0,0 @@
-# Create a template
-
-**POST** `/v1/templates`
-
-**Operation ID**: `createTemplate`
-**Summary**: Create a template
-Creates a new template for generating job subgraphs.
-
-## Tags
-- Templates
-## Request Body
-
-The template to create.
-
-**Content-Type**: `application/json`
-
-**Schema**: `Template`
-
-## Responses
-
-### 200
-
-Template created successfully
-
-### 400
-
-Invalid template data
-
-### 401
-
-Unauthorized

package/build/dist/docs-index/8bce46bd-f622-43bd-a9e3-402043103a6d.json

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

package/build/dist/docs-index/8bce46bd-f622-43bd-a9e3-402043103a6d.txt

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

package/build/dist/docs-index/8c5af17e-166c-4265-ae8c-81fd22bf4549.json

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

package/build/dist/docs-index/8c5af17e-166c-4265-ae8c-81fd22bf4549.txt

@@ -1,20 +0,0 @@
-# UserInfo
-
-Base class for the information of a user signing up.
-
-**Type**: `object`
-
-## One Of
-
-This schema accepts one of the following types:
-
-### Option 1
-`DatabaseUserInfo`
-
-### Option 2
-`SocialUserInfo`
-
-## Properties
-
-- name: type (required)
-  type: string

package/build/dist/docs-index/8d3bbd0e-ee8e-4be5-9fb1-d02a8a660c97.json

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

package/build/dist/docs-index/8d3bbd0e-ee8e-4be5-9fb1-d02a8a660c97.txt

@@ -1,25 +0,0 @@
-# Get AWS console setup information for a S3 Data Warehouse integration
-
-**GET** `/v1/integrations/s3-data-warehouse/console-setup-info`
-
-**Operation ID**: `getConsoleSetupInfo`
-**Summary**: Get AWS console setup information for a S3 Data Warehouse integration
-Gets AWS console setup information for an external S3 Data Warehouse integration
-
-## Tags
-- External S3 Data Warehouse Integration
-## Parameters
-
-- **bucketName** (optional) - query
-  - Type: string
-
-## Responses
-
-### 200
-
-AWS console setup information retrieved successfully
-
-- **Content-Type**: `application/json` / `ConsoleSetupInfo`
-### 401
-
-Unauthorized

package/build/dist/docs-index/8d4acfb5-a956-4915-8e3b-4e2fcb632e51.json

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

package/build/dist/docs-index/8d4acfb5-a956-4915-8e3b-4e2fcb632e51.txt

@@ -1,20 +0,0 @@
-# GreprMetricsSource
-
-**Type**: `object`
-
-## Properties
-
-- name: name (required)
-  type: string
-
-- name: metrics (optional)
-  type: array of enum: `table_totalBytes`, `job_operator_numRecordsIn`, `job_operator_numRecordsOut`, `job_operator_numRecordsInPerSecond`, `job_operator_numRecordsOutPerSecond`, `job_operator_numRecordsSend`
-  description: The list of metrics to load. Will load all possible metrics if nothing is specified
-
-- name: additionalTags (optional)
-  type: object
-  description: Additional tags to add to the metrics while loading.
-
-- name: type (required)
-  type: enum: `grepr-metrics-source`
-  description: Reads metric events from Grepr for processing.

package/build/dist/docs-index/8d52a724-8815-4d2b-82cc-3a9fe2f987ea.json

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

package/build/dist/docs-index/8d52a724-8815-4d2b-82cc-3a9fe2f987ea.txt

@@ -1,31 +0,0 @@
-# Validate a log sample
-
-**POST** `/v1/grok/parse`
-
-**Operation ID**: `parse_1`
-**Summary**: Validate a log sample
-Parses a log sample using provided Grok rules and returns the extracted fields and which rule matched.
-
-## Tags
-- Grok Parsing
-## Request Body
-
-**Content-Type**: `application/json`
-
-**Schema**: `GrokParseRequest`
-
-## Responses
-
-### 200
-
-Log message parsed successfully.
-
-- **Content-Type**: `application/json` / `GrokParseResponse`
-### 400
-
-Grok parsing rules are invalid or could not be compiled.
-
-- **Content-Type**: `application/json` / `GrokParseErrors`
-### 401
-
-Unauthorized

package/build/dist/docs-index/8dd41ade-6712-463f-9172-7af4defc5331.json

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

package/build/dist/docs-index/8dd41ade-6712-463f-9172-7af4defc5331.txt

@@ -1,13 +0,0 @@
-# DatadogQueryPredicate
-
-**Type**: `object`
-
-## Properties
-
-- name: query (required)
-  type: string
-  description: The datadog query used by the predicate. See https://docs.datadoghq.com/tracing/trace_explorer/query_syntax
-
-- name: type (required)
-  type: enum: `datadog-query`
-  description: A predicate that checks if an event matches a datadog query.

package/build/dist/docs-index/8e4bad9c-c425-4d22-ab0d-bc2a7ccc4bf3.json

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

package/build/dist/docs-index/8e4bad9c-c425-4d22-ab0d-bc2a7ccc4bf3.txt

@@ -1,20 +0,0 @@
-# OtlpTraceSink
-
-**Type**: `object`
-
-## Properties
-
-- name: name (required)
-  type: string
-
-- name: integrationId (required)
-  type: string
-  description: The OTLP integration id.
-
-- name: additionalAttributes (optional)
-  type: object
-  description: Additional attributes to add to the logs when writing to OTLP destination. Gets combined with the integration's additionalAttributes.
-
-- name: type (required)
-  type: enum: `otlp-trace-sink`
-  description: Writes processed logs to any OTLP-compatible destination.

package/build/dist/docs-index/8f1d6e35-0743-415a-8d1b-79a079eccaea.json

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

package/build/dist/docs-index/8f1d6e35-0743-415a-8d1b-79a079eccaea.txt

@@ -1,38 +0,0 @@
-# Create a new user
-
-**POST** `/v1/users`
-
-**Operation ID**: `createUser`
-**Summary**: Create a new user
-Create a new user and add them to the organization.
-
-## Tags
-- Users
-## Request Body
-
-**Content-Type**: `application/json`
-
-**Schema**: `CreateUser`
-
-## Responses
-
-### 200
-
-User created successfully
-
-- **Content-Type**: `application/json` / `ReadUser`
-### 400
-
-Invalid user data
-
-### 401
-
-Unauthorized
-
-### 403
-
-Unauthorized
-
-### 409
-
-User already exists

package/build/dist/docs-index/8f529be8-deee-401d-8e08-32da32e35bce.json

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

package/build/dist/docs-index/8f529be8-deee-401d-8e08-32da32e35bce.txt

@@ -1,80 +0,0 @@
----
-description: Learn how Grepr uses Apache Iceberg and Apache Parquet with cloud storage to deploy data lakes optimized for log storage and querying.
----
-
-import { Callout } from 'nextra/components'
-import { HiddenFAQ } from '@/components/HiddenFAQ'
-
-# The Grepr data lake
-
-Grepr pipelines use a data lake deployed on Amazon S3 to store data, including raw logs and metadata, across different processing stages. The metadata stored in the data lake can include patterns identified during log message processing or message identifiers. You can also choose to save the processed output events from your pipelines in the data lake.
-
-The data lake uses [Apache Iceberg](https://iceberg.apache.org/) and [Apache Parquet](https://parquet.apache.org/) to create a storage layer optimized for storing and querying large datasets. Both Iceberg and Parquet are open-source projects that are widely used to support data engineering workloads.
-
-Iceberg is a table format designed to store and query large datasets efficiently. Parquet is a column-oriented storage format designed for efficient data storage and retrieval. The Grepr data lake stores data in Parquet files, and Iceberg manages them as tables. The combination of Iceberg and Parquet provides efficient data storage and support for database-like functionality, including queries, transactions, and schema evolution.
-
-Although you configure each of your pipelines with a single data lake, an S3 bucket can host multiple data lakes. In the data lake, Grepr stores data in _datasets_. A Grepr dataset defines a namespace in the data lake that identifies where specific data is stored and isolates that data from other datasets.
-
-An example of a dataset is the one you add to a pipeline to capture the pipeline's output. However, a dataset is not restricted to a single pipeline: You can create a dedicated dataset for a single pipeline or configure multiple pipelines to use a shared dataset.
-
-## How does Grepr use the data lake?
-
-Grepr uses the data stored in the data lake for tasks such as querying raw data or performing backfills. To limit the amount of data required for scans and the associated costs, you should be as precise as possible when you run queries against this data. For example, limit the amount of data scanned by using tags and limited time ranges.
-
-<Callout type="info">
-  By default, Grepr sets the following limits for queries against data lake tables:
-
-  - 100 GB for the amount of data that can be scanned in a single query.
-  - A timeout of 10 minutes. The Grepr platform terminates queries that exceed this time limit.
-
-  Although these limits are sufficient for most queries, if your workloads require raising these limits, contact [support@grepr.ai](mailto:support@grepr.ai).
-</Callout>
-
-## How is a Grepr data lake deployed?
-
-Because the Grepr platform manages the deployment of the data lake infrastructure, including creation of the required tables and other structures, you don't need to take additional steps to install or configure Iceberg or Parquet. When you add a data lake in the pipelines UI, you only need to configure a storage integration with S3, either using a Grepr-hosted S3 bucket or a self-hosted S3 bucket. To learn how to create and configure an S3 bucket and Grepr storage integration, see [Host a Grepr data lake with the Amazon S3 integration](/integrations/aws-s3).
-
-When you use the API to configure a pipeline, the Grepr platform also manages the deployment of the tables and other structures required by the data lake. However, your pipeline configuration must include specific values related to Iceberg sources and sinks. To learn more, see [Create and manage jobs with the Grepr REST API](/apis/job-creation-guide).
-
-<HiddenFAQ faqs={[
-  {
-    q: "What is the Grepr data lake?",
-    a: "The Grepr data lake is a cloud-based storage layer built on Amazon S3 that stores raw log data and metadata. It uses Apache Iceberg for table management and Apache Parquet for columnar storage, providing efficient querying and cost-effective long-term retention."
-  },
-  {
-    q: "Why does Grepr use Apache Iceberg and Parquet?",
-    a: "Iceberg provides a table format designed for efficient storage and querying of large datasets with full transaction support and schema evolution. Parquet offers column-oriented storage optimized for analytical queries, enabling fast retrieval and compression of log data."
-  },
-  {
-    q: "What is a Grepr dataset?",
-    a: "A Grepr dataset is a namespace within the data lake that identifies where specific data is stored and isolates it from other datasets. You can configure pipelines to use dedicated datasets or share datasets across multiple pipelines."
-  },
-  {
-    q: "What can I use the data lake for?",
-    a: "You can use the data lake for querying raw historical logs, performing backfills during incidents, analyzing patterns, running batch analytics, and maintaining a complete audit trail of all ingested data."
-  },
-  {
-    q: "Can multiple S3 buckets host Grepr data lakes?",
-    a: "Yes, a single S3 bucket can host multiple independent data lakes, each with their own isolated datasets. This allows flexible organization of data while sharing infrastructure."
-  },
-  {
-    q: "What are the query limits for the data lake?",
-    a: "By default, Grepr limits data lake queries to 100 GB of scanned data per query and enforces a 10-minute timeout. These limits can be increased for specific workloads by contacting support."
-  },
-  {
-    q: "How do I set up a data lake?",
-    a: "Create a storage integration with Amazon S3 (either Grepr-hosted or self-hosted). Grepr automatically manages table creation and Iceberg/Parquet configuration. No manual setup of Iceberg or Parquet is required."
-  },
-  {
-    q: "Can I store pipeline outputs in the data lake?",
-    a: "Yes, you can configure pipelines to save processed output events to the data lake. This allows you to retain transformed data alongside raw logs for comprehensive analysis."
-  },
-  {
-    q: "How does the data lake support backfills?",
-    a: "During incidents, Grepr automatically backtransfers relevant raw logs from the data lake to your observability platform. This is enabled by the efficient querying capabilities of Iceberg and Parquet storage."
-  },
-  {
-    q: "Is my data in the data lake secure?",
-    a: "Yes, data in the data lake is encrypted at rest using strong encryption standards and protected by AWS security features. Data is stored in your S3 bucket under your control with strict access limitations."
-  }
-]} />

package/build/dist/docs-index/90497e4d-9694-445c-8f7f-262f05d5a49e.json

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

package/build/dist/docs-index/90497e4d-9694-445c-8f7f-262f05d5a49e.txt

@@ -1,37 +0,0 @@
-# QueryJobInfo
-
-Information about a query job.
-
-**Type**: `object`
-
-## Properties
-
-- name: flinkJobId (required)
-  type: `JobID`
-
-- name: status (required)
-  type: enum: `PENDING`, `RUNNING`, `FINISHED`, `UNKNOWN`, `FAILED`, `TIMEOUT`, `CANCELLED`
-  description: The status of the query job.
-
-- name: resultPath (required)
-  type: string
-  description: The path where results from the query job will be available.
-
-- name: jobExpiry (required)
-  type: string
-  description: The time at which the job will expire. After this time, the job is bound to be terminated and any new results will not be made available.
-
-- name: nextHeartbeatTime (required)
-  type: string
-  description: The time after which the client should send a heartbeat. If no new heartbeats are received a certain amount of time after this, the job is bound to be terminated. To send heartbeats, do a query read.
-
-- name: integrationId (optional)
-  type: string
-  description: The integration id used for the query job. This determines where the results will be stored.
-
-- name: metadata (optional)
-  type: `QueryJobMetadata`
-
-- name: results (optional)
-  type: object
-  description: The results of the query job. The keys are the names of the result files and the values are the paths to them.

package/build/dist/docs-index/90c72e03-c694-4276-b355-d5f4451a9359.json

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

package/build/dist/docs-index/90c72e03-c694-4276-b355-d5f4451a9359.txt

@@ -1,25 +0,0 @@
-# AvailablePermission
-
-**Type**: `object`
-
-## Properties
-
-- name: id (required)
-  type: string
-  description: Unique identifier for this permission
-
-- name: action (required)
-  type: string
-  description: Action being permitted (e.g., view, edit)
-
-- name: resource (required)
-  type: string
-  description: Resource type (e.g., jobs, users, integrations)
-
-- name: description (required)
-  type: string
-  description: Human-readable description of what this permission allows
-
-- name: category (required)
-  type: string
-  description: The category that the permission belongs to

package/build/dist/docs-index/91c382fe-ba5f-475c-901e-4101b3e24904.json

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