@grepr/cli 1.2.0 → 1.3.0-4e666db

package/build/dist/docs-index/e4de75bf-f316-4636-b93e-b28b9b834cbb.json

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

package/build/dist/docs-index/e4de75bf-f316-4636-b93e-b28b9b834cbb.txt

@@ -1,12 +0,0 @@
-# SpansSynchronousSink
-
-**Type**: `object`
-
-## Properties
-
-- name: name (required)
-  type: string
-
-- name: type (required)
-  type: enum: `spans-sync-sink`
-  description: Sink for returning results to the caller.

package/build/dist/docs-index/e62b2d0b-6ade-414c-9ef6-ecc7fbde66f4.json

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

package/build/dist/docs-index/e62b2d0b-6ade-414c-9ef6-ecc7fbde66f4.txt

@@ -1,19 +0,0 @@
-# TemplateDraftOutput
-
-Describes an additional output that will be added to the job graph when running a template in draft mode.
-
-**Type**: `object`
-
-## Properties
-
-- name: name (optional)
-  type: string
-  description: Name of the draft output.
-
-- name: tagKey (optional)
-  type: string
-  description: Tag key that will be added to the draft output.
-
-- name: tagValue (optional)
-  type: string
-  description: Tag value that will be added to the draft output.

package/build/dist/docs-index/e642b878-17ff-46c3-aab7-a69a6b6408d7.json

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

package/build/dist/docs-index/e642b878-17ff-46c3-aab7-a69a6b6408d7.txt

@@ -1,19 +0,0 @@
-# DatadogLogAgentSource
-
-**Type**: `object`
-
-## Properties
-
-- name: name (required)
-  type: string
-
-- name: integrationId (required)
-  type: string
-  description: The integration id for the observability vendor.
-
-- name: hostEnrichmentEnabled (optional)
-  type: boolean
-
-- name: type (required)
-  type: enum: `datadog-log-agent-source`
-  description: Reads log events from Grepr's Datadog collection agent. This is used to pre-process logs before being sent to Datadog.

package/build/dist/docs-index/e666f860-806f-4c1e-89b6-e5a1e9da79aa.json

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

package/build/dist/docs-index/e666f860-806f-4c1e-89b6-e5a1e9da79aa.txt

@@ -1,9 +0,0 @@
-# MaxAttributesMergeStrategy
-
-**Type**: `object`
-
-## Properties
-
-- name: type (required)
-  type: enum: `max`
-  description: MaxAttributesMergeStrategy: Keeps the maximum numeric attribute value.

package/build/dist/docs-index/e6acc689-c953-4ad9-a2b3-a0f85bc86d8e.json

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

package/build/dist/docs-index/e6acc689-c953-4ad9-a2b3-a0f85bc86d8e.txt

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

package/build/dist/docs-index/e6f653e4-a73c-4bcf-bc7c-0d73caebb498.json

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

package/build/dist/docs-index/e6f653e4-a73c-4bcf-bc7c-0d73caebb498.txt

@@ -1,20 +0,0 @@
-# List all SumoLogic integrations
-
-**GET** `/v1/integrations/sumo`
-
-**Operation ID**: `list_6`
-**Summary**: List all SumoLogic integrations
-Get all SumoLogic integrations.
-
-## Tags
-- Sumo Logic Integration
-## Responses
-
-### 200
-
-Integrations retrieved successfully
-
-- **Content-Type**: `application/json` / `ItemsCollectionReadSumo`
-### 401
-
-Unauthorized

package/build/dist/docs-index/e77cca99-6ed6-43a5-a520-7405a9587845.json

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

package/build/dist/docs-index/e77cca99-6ed6-43a5-a520-7405a9587845.txt

@@ -1,29 +0,0 @@
-# Read the status of a query job.
-
-**POST** `/v1/jobs/query/read`
-
-**Operation ID**: `read`
-**Summary**: Read the status of a query job.
-Read the status of a query job using the token received when the job was submitted or was last queried. The response contains the job details including the status, result paths, etc., and a new token that can be used to further query for the job details should anything change. Once the job is finished, any more calls to this endpoint before expiry will yield the same result.
-
-## Tags
-- Query Jobs
-## Request Body
-
-**Content-Type**: `application/json`
-
-**Schema**: `QueryJobToken`
-
-## Responses
-
-### 200
-
-Query job status read successfully. The response contains the job details.
-
-### 401
-
-Unauthorized
-
-### 404
-
-Job details corresponding to the token were not found. They probably expired.

package/build/dist/docs-index/e7c62785-bc10-4a62-a625-f1d56d8504a6.json

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

package/build/dist/docs-index/e7c62785-bc10-4a62-a625-f1d56d8504a6.txt

@@ -1,15 +0,0 @@
-# LogTransformAction
-
-**Type**: `object`
-
-## Properties
-
-- name: name (required)
-  type: string
-
-- name: transforms (optional)
-  type: array of `EventAction`
-
-- name: type (required)
-  type: enum: `log-transform`
-  description: Applies transformations to log events.

package/build/dist/docs-index/e7ff787f-534a-4f54-af63-634a269f723a.json

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

package/build/dist/docs-index/e7ff787f-534a-4f54-af63-634a269f723a.txt

@@ -1,39 +0,0 @@
-# Datadog
-
-The payload containing integration data.
-
-**Type**: `object`
-
-## Properties
-
-- name: site (required)
-  type: string
-  description: Datadog site URL
-
-- name: filterQuery (required)
-  type: string
-  description: Filter to apply when reading any data from the Datadog API
-
-- name: additionalTags (required)
-  type: array of string
-  description: Tags to add when writing data to Datadog
-
-- name: apiKey (optional)
-  type: string
-  description: Masked API key for Datadog
-
-- name: appKey (optional)
-  type: string
-  description: Masked App key for Datadog
-
-- name: validateKeysOnSave (optional)
-  type: boolean
-  description: Indicates whether to validate the API and App keys when saving the keys.
-
-- name: clientToken (optional)
-  type: string
-  description: Client token for Datadog
-
-- name: exceptions (optional)
-  type: object
-  description: The imported exceptions from Datadog. This is a map from the vendor resource Id to the exception.

package/build/dist/docs-index/e85d2fc8-0867-4799-9bc3-74b226b6174e.json

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

package/build/dist/docs-index/e85d2fc8-0867-4799-9bc3-74b226b6174e.txt

@@ -1,132 +0,0 @@
----
-description: Learn how the Grepr remapper is used to transform and standardize log event fields during pipeline processing.
----
-
-import { HiddenFAQ } from '@/components/HiddenFAQ'
-
-# Remap JSON attribute fields to top-level log event fields
-
-The remapper transform moves or copies attributes to top-level log event fields (such as `message` or `eventTimestamp`) or to tags. The remapper processes a set of predefined parameters, but you can modify this list based on your requirements.
-
- When you use the Grepr UI to create a pipeline, a remapper that transforms well-known fields is automatically added to the pipeline.
-
-## Example transformation
-
-For example, this event:
-
-```json
-{
-  "id": "ABCDEF",
-  "eventTimestamp": 1765481731051,
-  "message": "",
-  "severity": "",
-  "tags": {},
-  "attributes": {
-    "syslog": {
-      "severity": "10",
-      "appname": "test name"
-    },
-    "status": "5",
-    "msg": "message 1",
-    "timestamp": {
-      "ms_since_epoch": 1765481730000
-    },
-    "eventTime": " "
-  }
-}
-```
-
-Would be transformed using the default configuration to:
-
-```json
-{
-  "id": "ABCDEF",
-  "eventTimestamp": 1765481731051,
-  "message": "message 1",
-  "severity": "5",
-  "tags": {
-    "service": "test name"
-  },
-  "attributes": {
-    "syslog": {
-      "severity": "10",
-      "appname": "test name"
-    },
-    "status": "5",
-    "timestamp": {
-      "ms_since_epoch": 9001
-    },
-    "eventTime": " ",
-    "greprMeta": {
-      "messageAttributePath": "msg"
-    }
-  }
-}
-```
-
-- `severity` uses `status: "5"` instead of `syslog.severity: "10"` because `status` has a higher priority in the default configuration.
-- `tags.service` uses `syslog.appname: "test name"`.
-- The attribute `msg` was removed because it was remapped to the top-level `message` field.
-  - The `greprMeta.messageAttributePath` attribute was added to indicate which attribute was used for the remapped `message` field.
-  - If the message attribute is a nested field (e.g., `log.msg`), only the msg field is removed. The parent `log` object remains, even if it is empty.
-- `timestamp: {}` and `eventTime: " "` are not used because they do not contain a valid timestamp value.
-
-## Default configuration
-
-The following are the default settings:
-
-| Attribute | Removed | Default names                                                                                                        |
-|:----------|:--------|:---------------------------------------------------------------------------------------------------------------------|
-| timestamp | false   | `date`, `@timestamp`, `T`, `syslog.timestamp`, `eventTime`, `_timestamp`, `Timestamp`, `published_date`, `timestamp` |
-| host      | false   | `hostname`, `sourceIPAddress`, `host`, `kubernetes.host`, `syslog.hostname`                                          |
-| service   | false   | `dd.service`, `kubernetes.labels.app`, `service`, `eventSource`, `kubernetes.labels.k8s-app`, `syslog.appname`       |
-| status    | false   | `severity`, `level`, `syslog.severity`, `log.level`, `L`, `status`                                                   |
-| message   | true    | `msg`, `log`, `message`, `M`                                                                                         |
-| trace ID  | false   | `dd.trace_id`, `contextMap.dd.trace_id`, `otelTraceId`                                                               |
-
-For the full list of default configuration settings, see [LogAttributesRemapper](/apis/api-spec#schema/LogAttributesRemapper).
-
-<HiddenFAQ
-  faqs={[
-    {
-      q: "What does the remapper transform do?",
-      a: "The remapper transform moves or copies attributes from nested JSON structures to top-level log event fields (like message, severity, host, timestamp) or to tags. This standardizes log event structure and makes important fields easily accessible for filtering, searching, and display."
-    },
-    {
-      q: "Is the remapper automatically applied in the Grepr UI?",
-      a: "Yes, when you create a pipeline using the Grepr UI, a remapper is automatically added with a set of predefined default attributes for well-known field names. You can modify this configuration based on your specific requirements."
-    },
-    {
-      q: "What are the default field mappings for the remapper?",
-      a: "The default configuration includes mappings for: timestamp (from date, @timestamp, syslog.timestamp, etc.), host (from hostname, sourceIPAddress, kubernetes.host), service (from dd.service, kubernetes.labels.app, syslog.appname), status (from severity, level, log.level), message (from msg, log, message), and trace ID (from dd.trace_id, otelTraceId)."
-    },
-    {
-      q: "How does field priority work in the remapper?",
-      a: "The remapper uses priority to select which source attribute to map when multiple candidates exist. For example, if both 'status' and 'syslog.severity' are present, the remapper uses the one with higher priority. The default configuration specifies priority ordering for well-known fields."
-    },
-    {
-      q: "What happens to the original attribute after remapping?",
-      a: "By default, remapped attributes are removed from the attributes object unless the 'Removed' setting is false for that field. For example, the message field has 'Removed: true', so the original 'msg' attribute is deleted after being copied to the top-level message field. For fields like timestamp with 'Removed: false', the original attribute remains."
-    },
-    {
-      q: "How do I customize the remapper configuration?",
-      a: "You can modify the default attribute names and their priority by editing the remapper configuration. This allows you to map custom field names from your logs to standard top-level fields. Access these settings when configuring the remapper step in your pipeline."
-    },
-    {
-      q: "What is greprMeta and why is it added?",
-      a: "greprMeta is a metadata field added by the remapper to track remapping information. It includes messageAttributePath, which indicates which attribute was used for the remapped message field. This provides an audit trail of where the message content originated from."
-    },
-    {
-      q: "Can I remap attributes to tags instead of top-level fields?",
-      a: "Yes, the remapper can copy or move attributes to the tags section of a log event. For example, you can map syslog.appname to a tag like tags.service. This is useful for adding contextual information for filtering and categorization without cluttering the top-level fields."
-    },
-    {
-      q: "What happens if a remapping source field is empty or has an invalid value?",
-      a: "The remapper handles invalid values gracefully. For timestamp fields, if the value doesn't contain a valid timestamp, it's not used for remapping. Empty values are also skipped. The remapper continues to the next priority option if the current source field is invalid."
-    },
-    {
-      q: "Can I use the remapper with nested field paths?",
-      a: "Yes, the remapper supports nested field paths like syslog.severity and kubernetes.host. When remapping a nested field, only the immediate field is removed from the parent object if the removal setting is true. Parent objects are preserved even if they become empty after field removal."
-    }
-  ]}
-/>

package/build/dist/docs-index/e87a2d65-e3f3-48b9-aaf4-fb27fb96c2e3.json

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

package/build/dist/docs-index/e87a2d65-e3f3-48b9-aaf4-fb27fb96c2e3.txt

@@ -1,152 +0,0 @@
----
-description: Learn how to manage your Grepr users with the user management UI.
----
-
-import { Callout } from 'nextra/components'
-import { HiddenFAQ } from '@/components/HiddenFAQ'
-
-# Manage users in the Grepr platform
-
-The administrative features in the Grepr platform support managing users in your organization, including viewing users, editing users' and roles' permissions, and removing users. This page describes the user management features available in the Grepr UI, including how to access those features and perform common user management tasks.
-
-You also have full control of users' access to Grepr features by assigning users to roles. You can use built-in organization-level roles, such as Admin and Member, or create custom roles with specific permissions.
-
-You can organize users into teams that you create in the user management UI. To learn more about the team features and how to manage teams, see [Manage teams in the Grepr platform](/admin/manage-teams).
-
-You can manage users and roles in the Grepr UI or the REST API. This page describes how to manage users in the UI. To use the API, see the [Users specification](/apis/api-spec#tag/Users) and the [Roles specification](/apis/api-spec#tag/Roles).
-
-<Callout>
-  You must have the `view:users` permission to access the user management UI. This permission is granted to organization Admins and team Leaders.
-</Callout>
-
-## User roles in the Grepr platform
-
-The Grepr platform includes two built-in organization-level roles:
-
-- Admin: Admins have full access to all organization resources and settings, including user management features.
-- Member: Members have access to view resources, users, and teams, run backfill jobs, and query logs. Members cannot manage users, organization settings, or resources such as integrations or jobs.
-
-For details on the permissions for these roles, see [Permissions in the Grepr platform](/grepr-platform/permissions).
-
-To learn how to create custom roles with specific permissions, see [Custom roles](#create-custom-roles).
-
-## Access user management features in the UI
-
-To manage users in the Grepr UI:
-
-1. Sign in to the Grepr UI and click your profile icon in the top bar.
-1. In the menu, select **User Management**.
-1. On the **User Management** page, click **Users** in the left pane to display the **Users** pane with a list of all users and information about each user, such as the user's name, email address, role, and teams.
-
-The following sections describe how to perform user management tasks in the UI.
-
-## Add users by invitation
-
-Users are added to your organization when they respond to an emailed _invitation_. To invite a new user:
-
-1. In the **Users** pane, click **Invite new users**.
-1. In the **Invite users** dialog:
-   - In the **Invite Emails** field, enter one or more email addresses for the users to invite.
-   - (Optional) In the **Roles (Optional)** field, select the roles to assign to the invited users.
-   - (Optional) To assign a user to one or more teams, click **Add Team Assignment**.
-     - In the **Teams** menu, select the team to assign.
-     - In the **Role** menu, select the team role to assign.
-     - To add multiple teams, click **Add Team Assignment** again.
-1. Click **Send**.
-
-The **Invitations** table shows information for all pending invitations. From the table, you can delete pending invitations if they're no longer needed. Invitations automatically expire after a set period.
-
-## Edit users
-
-To edit a user's name, email, or roles:
-
-1. In the **Users** pane, find the user you want to edit in the **Users** table.
-1. Click the three-dot menu in the **Actions** column for that user.
-1. Select **Edit**.
-1. In the **Edit User** dialog, update the user's information and click **Save**.
-
-## Remove users
-
-To remove a user:
-
-1. In the **Users** pane, find the user you want to remove in the Users table.
-1. Click the three-dot menu in the **Actions** column for that user.
-1. Select **Delete**.
-1. In the **Confirm Delete** dialog, click **Delete**.
-
-The user is removed from your organization, and their access is revoked.
-
-## Custom roles [#create-custom-roles]
-
-If you need more control over access than the Admin and Member roles provide, you can create custom roles. Custom roles let you define specific permissions for different resources. You can select specific resources for access control, such as jobs, users, teams, integrations, templates, or datasets, and assign only required permissions, such as view, edit, create, delete, or all, on those resources.
-
-### Create custom roles
-
-To create a custom role in the UI:
-
-1. On the **User Management** page, click **Roles** in the left pane to display the **Roles** pane.
-1. Click **+ Create**.
-1. In the **Create Custom Role** dialog:
-   - Enter a **Role Name**.
-   - (Optional) Enter a **Description** for the role.
-   - In the **Permissions** section, select the required permissions for each resource.
-1. Click **Create Role**.
-
-## User and role management best practices
-
-### Role management
-
-- Use custom roles only if the existing Admin and Member roles don't meet your access requirements.
-- Document custom roles by including a role description that clearly explains the permissions it grants.
-- Follow the principle of least privilege and grant users only the access they need.
-- Use clear and descriptive names when you create custom roles.
-
-### Invitations
-
-- To streamline onboarding, when you create an invitation, include team assignments in the invitation.
-- Regularly review and delete old, unaccepted invitations.
-
-<HiddenFAQ
-  faqs={[
-    {
-      q: "What are the built-in roles in Grepr and what can each role do?",
-      a: "Grepr has two built-in organization-level roles: Admin (full access to all resources and settings including user management) and Member (can view resources, users, teams, run backfill jobs, and query logs but cannot manage users or create/edit resources). These can be supplemented with custom roles for fine-grained access control."
-    },
-    {
-      q: "How do I invite multiple users at once?",
-      a: "In the Invite users dialog, enter multiple email addresses in the Invite Emails field separated by line breaks. You can also optionally assign roles and team memberships to all invited users before sending the invitations."
-    },
-    {
-      q: "Can I assign users to teams during the invitation process?",
-      a: "Yes, when creating an invitation, you can click 'Add Team Assignment' to assign invited users to specific teams with their desired team role (Leader or Member) before they even accept the invitation."
-    },
-    {
-      q: "How long are user invitations valid?",
-      a: "Invitations automatically expire after a set period. You should regularly review the Invitations table and delete old, unaccepted invitations to keep your organization clean."
-    },
-    {
-      q: "What information can I edit about a user?",
-      a: "You can edit a user's name, email address, and roles. You can also modify their organization-level roles and team assignments through the Edit User dialog."
-    },
-    {
-      q: "How do I create a custom role with specific permissions?",
-      a: "Click on the Roles tab in the User Management page, then click '+ Create'. In the Create Custom Role dialog, enter a role name and description, then select the specific permissions needed for each resource type (jobs, users, integrations, etc.)."
-    },
-    {
-      q: "Can I edit a custom role after creating it?",
-      a: "Yes, you can edit custom roles to change the permissions they grant. Any changes to a custom role automatically apply to all users assigned to that role."
-    },
-    {
-      q: "What happens when I remove a user from the organization?",
-      a: "Removing a user revokes all their access to the organization. They lose access to all organization-level resources and all team-scoped resources immediately."
-    },
-    {
-      q: "Should I use custom roles or the built-in Admin and Member roles?",
-      a: "Use the built-in Admin and Member roles when they meet your access requirements. Only create custom roles when you need access control that the built-in roles don't provide, such as read-only access to specific resources."
-    },
-    {
-      q: "How do I manage user access at scale?",
-      a: "For large organizations, combine organization-level roles with team-based access control. Use teams to scope access to resources, custom roles for fine-grained permissions, and follow the principle of least privilege when assigning access."
-    }
-  ]}
-/>

package/build/dist/docs-index/eb725123-5a7a-47b5-91c0-34c5b6431e81.json

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

package/build/dist/docs-index/eb725123-5a7a-47b5-91c0-34c5b6431e81.txt

@@ -1,33 +0,0 @@
-# Role
-
-**Type**: `object`
-
-## Properties
-
-- name: id (required)
-  type: string
-  description: The id of the role.
-
-- name: name (required)
-  type: string
-  description: The user-facing name of the role.
-
-- name: description (required)
-  type: string
-  description: Description of the role
-
-- name: builtin (optional)
-  type: boolean
-  description: Whether this is a built-in role
-
-- name: permissionIds (required)
-  type: array of string
-  description: Permission IDs assigned to this role (empty for system roles)
-
-- name: createdAt (optional)
-  type: string
-  description: When the role was created (null for system roles)
-
-- name: createdBy (optional)
-  type: string
-  description: Who created the role (null for system roles)

package/build/dist/docs-index/ebc108b6-b130-4420-85b3-5795efc4a53a.json

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

package/build/dist/docs-index/ebc108b6-b130-4420-85b3-5795efc4a53a.txt

@@ -1,16 +0,0 @@
-# OtlpTraceAgentSource
-
-**Type**: `object`
-
-## Properties
-
-- name: name (required)
-  type: string
-
-- name: integrationId (required)
-  type: string
-  description: The integration id for the observability vendor.
-
-- name: type (required)
-  type: enum: `otlp-trace-agent-source`
-  description: Reads trace events from an OpenTelemetry collector. This is used to process traces from OTLP trace ingestion.

package/build/dist/docs-index/ec3bf098-22aa-47d5-a22b-31eb7667b978.json

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

package/build/dist/docs-index/ec3bf098-22aa-47d5-a22b-31eb7667b978.txt

@@ -1,34 +0,0 @@
-# Creates or updates an API key for integration with New Relic
-
-**PUT** `/v1/integrations/newrelic/{id}/api-key`
-
-**Operation ID**: `upsertApiKey_1`
-**Summary**: Creates or updates an API key for integration with New Relic
-Creates a NewRelic API key for a NewRelic integration if a key doesn't exist, and updates it otherwise. If the api key is updated while the integration is being used by a pipeline, the  new key is used at pipeline restart, rescaling, or an update.  This key is used for the NewRelic API to retrieve the dashboards and alerts.
-
-## Tags
-- New Relic Integration
-## Parameters
-
-- **id** (required) - path
-  - Type: string
-
-## Request Body
-
-**Content-Type**: `application/json`
-
-**Schema**: `SecretApi`
-
-## Responses
-
-### 204
-
-NewRelic API key upserted successfully.
-
-### 401
-
-Unauthorized
-
-### 404
-
-Integration not found.

package/build/dist/docs-index/ecf8c655-4173-499a-acc9-e24222cb60f3.json

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

package/build/dist/docs-index/ecf8c655-4173-499a-acc9-e24222cb60f3.txt

@@ -1,26 +0,0 @@
-# Validate whether Grepr can access the S3 bucket
-
-**POST** `/v1/integrations/s3-data-warehouse/test`
-
-**Operation ID**: `test`
-**Summary**: Validate whether Grepr can access the S3 bucket
-Validates whether Grepr can access the S3 bucket. This can be used to test the bucket access before creating the integration.
-
-## Tags
-- External S3 Data Warehouse Integration
-## Request Body
-
-**Content-Type**: `application/json`
-
-**Schema**: `WriteS3DataWarehouse`
-
-## Responses
-
-### 200
-
-Bucket access validation completed successfully
-
-- **Content-Type**: `application/json` / `BucketAccessResult`
-### 401
-
-Unauthorized

package/build/dist/docs-index/ed24e904-6fff-4b78-9426-4d481b22ad88.json

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