@grepr/cli 1.11.5 → 1.11.6-674b35e

package/build/dist/openapi-docs/schemas/TableConfigRead.md

@@ -8,10 +8,25 @@
   type: array of `EffectivePartitionField`
   description: Full effective partition spec, including system-controlled rows.
 
+- name: promotedAttributes (optional)
+  type: array of `PromotedAttribute`
+  description: Attribute paths the table indexes, with the policy applied to each.
+
 - name: promotedTagKeys (optional)
   type: array of string
-  description: Bare tag keys promoted to top-level columns.
+  description: The promotion policy's tags.include, verbatim: the tag keys a partition field may name besides the built-ins. Discovery alone does not add a key to this list, and service or host is listed only when included explicitly.
+
+- name: promotedTags (optional)
+  type: array of `PromotedTag`
+  description: Tag keys the table indexes, with the policy applied to each.
+
+- name: promotion (required)
+  type: `PromotionPolicy`
 
 - name: sortFields (optional)
   type: array of `SortFieldConfig`
   description: Effective sort fields, in precedence order.
+
+- name: unreadableAttributeColumns (optional)
+  type: array of string
+  description: Attribute index columns whose name could not be decoded to a path.

package/build/dist/openapi-docs/schemas/UsageStatus.md

@@ -0,0 +1,19 @@
+# UsageStatus
+
+The outcome of the last attempt to read the integration's usage
+
+**Type**: `object`
+
+## Properties
+
+- name: collectedAt (optional)
+  type: string
+  description: When usage was last read successfully. The usage returned is as of this time; absent when it was never read.
+
+- name: detail (optional)
+  type: string
+  description: Why the last attempt failed, in words fit to show. Absent when it worked.
+
+- name: state (required)
+  type: enum: `OK`, `PENDING`, `PERMISSION_DENIED`, `NO_VIEWS`, `ERROR`
+  description: Whether the usage of the integration's parsed queries could be read

package/build/dist/openapi-docs/schemas/Variant.md

@@ -31,6 +31,9 @@
 - name: double (optional)
   type: number
 
+- name: emptyObject (optional)
+  type: boolean
+
 - name: float (optional)
   type: number
 

package/build/dist/openapi-docs/schemas/VendorEstimationRun.md

@@ -28,17 +28,13 @@
   type: integer
   description: Distinct predicates in the run, fixed at creation
 
-- name: queuedAhead (optional)
-  type: integer
-  description: Number of older runs still waiting for an active slot ahead of this one. Present only while the run is QUEUED.
-
 - name: requestedBy (optional)
   type: string
   description: Id of the user who started the run
 
 - name: resumeAfter (optional)
   type: string
-  description: When a throttled run's next slice is scheduled to fire
+  description: When a THROTTLED run will be counted again
 
 - name: scopeQuery (required)
   type: string
@@ -49,12 +45,12 @@
   description: Total events the scope matched over the window, the denominator
 
 - name: state (required)
-  type: enum: `QUEUED`, `RUNNING`, `THROTTLED`, `COMPLETE`, `PARTIAL`, `FAILED`
+  type: enum: `QUEUED`, `RUNNING`, `THROTTLED`, `STOPPED`, `COMPLETE`, `FAILED`
   description: Current run state
 
 - name: stopReason (optional)
   type: string
-  description: Why a PARTIAL run stopped early
+  description: Why a STOPPED run stopped: USER or TIMED_OUT
 
 - name: updatedAt (required)
   type: string

package/build/dist/openapi-docs/schemas/VendorEstimationRunPreview.md

@@ -12,10 +12,6 @@
   type: integer
   description: Exceptions the run would cover: every one the integration has imported
 
-- name: queuedAhead (optional)
-  type: integer
-  description: Runs that would start before this one if it were created now. Absent when a slot is free.
-
 - name: unparseable (required)
   type: array of `UnparseableException`
   description: Exceptions whose query could not be parsed at import and so cannot be counted, each with the parse error

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@grepr/cli",
-  "version": "1.11.5",
+  "version": "1.11.6-674b35e",
   "description": "Official Grepr CLI tool for submitting synchronous batch jobs with OAuth authentication",
   "main": "build/dist/grepr.js",
   "type": "module",

package/build/dist/docs-index/034d4d83-d5a5-4bd6-a14f-2de5d345fcb2.txt

@@ -1,33 +0,0 @@
-# Get a vendor estimation run
-
-**GET** `/v1/integrations/{integrationId}/exceptions/vendor-estimation-runs/{runId}`
-
-**Operation ID**: `getVendorEstimationRun`
-**Summary**: Get a vendor estimation run
-Returns the run's current state and progress. Poll this while the run is non-terminal; results land incrementally and are readable throughout.
-
-## Tags
-- Integration Exceptions
-## Parameters
-
-- **integrationId** (required) - path
-  - Integration id
-  - Type: string
-- **runId** (required) - path
-  - Run id
-  - Type: string
-
-## Responses
-
-### 200
-
-Run retrieved
-
-- **Content-Type**: `application/json` / `VendorEstimationRun`
-### 401
-
-Unauthorized
-
-### 404
-
-Not Found - Integration or run not found.

package/build/dist/docs-index/068d38f4-1380-4460-a806-d9688202aa88.txt

@@ -1,143 +0,0 @@
-A reference for the permission types in the Grepr platform, and which permissions are assigned to different roles.
-
-# Permissions in the Grepr platform
-
-This page is a reference to the permissions available in the Grepr platform. These permissions are assigned to users based on the user's role:
-
-* Organization-level roles: Admin, Member, and Reader
-* Team-level roles: Leader and Member
-
-A user can be assigned both an organization-level role and a team-level role. For example, an organization Member can also be a team Leader, giving them view access organization-wide and edit access to their team's resources.
-
-You can also create custom roles with a specific subset of Grepr platform permissions. To learn more about roles, including custom roles, see [Manage users in the Grepr platform](/admin/manage-users).
-
-At both the organization and team levels, there are three types of permissions:
-
-* View: Grants read-only access to specified resources.
-* Edit: Grants edit permissions over specified resources, including creating, editing, and deleting those resources.
-* Write: Grants permission to send data through an integration when the integration is used as a sink in a job, such as a backfill job that writes data to a vendor integration. Edit permission on an integration controls the integration's configuration. Write permission on an integration controls whether you can send data through it.
-
-Resources in the Grepr platform include your organization, vendor, and storage integrations, datasets, templates, users, teams, and jobs.
-
-The following sections provide more details on permissions in the Grepr platform and the permissions for each role type.
-
-## Available permissions in the Grepr platform
-
-This table lists all available permissions for organization and team-level roles:
-
-| Permission | Resource | Scope |
-| --- | --- | --- |
-| Edit | Organization settings | Organization |
-| View | Organization settings | Organization or Team |
-| Edit | Integrations | Organization or Team |
-| View | Integrations | Organization or Team |
-| Write | Integrations | Organization or Team |
-| Edit | Jobs | Organization or Team |
-| View | Jobs | Organization or Team |
-| Edit | Users | Organization |
-| View | Users | Organization or Team |
-| Edit | Teams | Organization or Team |
-| View | Teams | Organization or Team |
-| Edit | Templates | Organization or Team |
-| View | Templates | Organization or Team |
-| Edit | Datasets | Organization or Team |
-| View | Datasets | Organization or Team |
-
-## Permissions by role
-
-The following are the permissions granted to each role type in the Grepr platform:
-
-* Organization Admins have full control over all resources in the organization, including all team-scoped resources, and can write to any vendor integration.
-* Organization Members have view-only permissions to all resources in the organization, and have write permission on all vendor integrations so they can run backfill jobs.
-* Organization Readers have view-only permissions to all resources in the organization. Readers can query logs, but cannot create or edit any resources and cannot run backfill jobs that send data to a vendor integration.
-* Team Leaders have edit permissions for all resources scoped to their specific team or teams. This includes permissions to create and edit jobs, integrations, templates, and datasets assigned to the team, and to write to integrations assigned to the team. Team Leaders can also view all organization resources but only edit resources scoped to their team or teams.
-* Team Members have view-only permissions to resources scoped to their specific team or teams, plus write permission on integrations assigned to the team so they can run backfill jobs. A team Member can view resources assigned to the team and query logs, but does not have permission to create or edit resources, such as jobs, integrations, templates, or datasets, assigned to the team.
-* Teams can be granted access to resources, such as integrations, datasets, or templates, scoped at the organization level. When a team is granted access to a resource, team Leaders have edit permissions on the resource, and team Members have view-only permissions. However, to create or edit a job, such as a pipeline, a team Leader must have view permissions on all the integrations and datasets used by the job, and write permission on every vendor integration the job uses as a sink. For example, if a job is assigned to the `DevOps` team, but the team hasn't been granted access to an integration used in the job, a `DevOps` team Leader cannot edit or run the job.
-* To create a dataset, you must have edit permission on the integration the dataset belongs to.
-
-For each resource in the Grepr platform, this table shows the specific permissions granted to each role type at both the organization and team levels:
-
-| Permission | Resource | Access Scope | Organization Admin | Organization Member | Organization Reader | Team Leader | Team Member |
-| --- | --- | --- | --- | --- | --- | --- | --- |
-| View | Organization Settings | Organization | ✅ | ✅ | ✅ | ✅ | ✅ |
-| Edit | Organization Settings | Organization | ✅ | ❌ | ❌ | ❌ | ❌ |
-| View | Users | Organization | ✅ | ✅ | ✅ | ✅ | ❌ |
-| Edit | Users | Organization | ✅ | ❌ | ❌ | ❌ | ❌ |
-| View | Teams | Organization | ✅ | ✅ | ✅ | ✅ | ❌ |
-| Edit | Teams | Organization | ✅ | ❌ | ❌ | ❌ | ❌ |
-| View | Integrations | Organization | ✅ | ✅ | ✅ | ❌ | ❌ |
-| Edit | Integrations | Organization | ✅ | ❌ | ❌ | ❌ | ❌ |
-| Write | Integrations | Organization | ✅ | ✅ | ❌ | ❌ | ❌ |
-| View | Datasets | Organization | ✅ | ✅ | ✅ | ❌ | ❌ |
-| Edit | Datasets | Organization | ✅ | ❌ | ❌ | ❌ | ❌ |
-| View | Jobs | Organization | ✅ | ✅ | ✅ | ❌ | ❌ |
-| Edit | Jobs | Organization | ✅ | ❌ | ❌ | ❌ | ❌ |
-| View | Templates | Organization | ✅ | ✅ | ✅ | ✅ | ❌ |
-| Edit | Templates | Organization | ✅ | ❌ | ❌ | ❌ | ❌ |
-| View | Teams | Team | ✅ | ✅ | ✅ | ✅ | ✅ |
-| Edit | Teams | Team | ✅ | ❌ | ❌ | ✅ | ❌ |
-| View | Integrations | Team | ✅ | ✅ | ✅ | ✅ | ✅ |
-| Edit | Integrations | Team | ✅ | ❌ | ❌ | ✅ | ❌ |
-| Write | Integrations | Team | ✅ | ✅ | ❌ | ✅ | ✅ |
-| View | Datasets | Team | ✅ | ✅ | ✅ | ✅ | ✅ |
-| Edit | Datasets | Team | ✅ | ❌ | ❌ | ✅ | ❌ |
-| View | Jobs | Team | ✅ | ✅ | ✅ | ✅ | ✅ |
-| Edit | Jobs | Team | ✅ | ❌ | ❌ | ✅ | ❌ |
-| View | Templates | Team | ✅ | ✅ | ✅ | ✅ | ✅ |
-| Edit | Templates | Team | ✅ | ❌ | ❌ | ✅ | ❌ |
-
-## Organization roles vs. team roles
-
-This table describes the difference between organization-level and team-level roles. Users can have both types of roles:
-
-\| | Organization roles | Team roles | | :-------- | :----------------------------------------------------- | :------------------------------------------ | | Scope | Entire organization | A specific team | | Types | Admin, Member, Reader, or Custom Roles | Leader or Member | | Examples | - Admin: Full access to all resources and settings.\
-\- Member: View organization resources and run backfill jobs.\
-\- Reader: View organization resources and query logs only; no backfills to vendor integrations.\
-\- Custom role, such as "Developer": Specific permissions like "view all jobs, edit templates". | - Leader: Manage team members, create team-scoped integrations.\
-\- Member: View team resources and run backfill jobs to team integrations. |
-
-## Frequently Asked Questions
-
-### What are the main permission types in Grepr?
-
-The main permission types are View (grants read-only access to specified resources), Edit (grants permissions to create, edit, and delete specified resources), and Write (grants permission to send data through an integration when the integration is used as a sink in a job, such as a backfill). These permissions are assigned based on user roles at both organization and team levels.
-
-### What are organization-level roles?
-
-Organization-level roles control access across the entire organization. The standard roles are Admin (full control over all resources), Member (view access plus permission to run backfill jobs), and Reader (view-only access; no backfills to vendor integrations). You can also create custom roles with specific subsets of permissions tailored to your organization's needs.
-
-### What are team-level roles?
-
-Team-level roles control access to resources within a specific team. There are two team roles: Leader (edit permissions for team-scoped resources and view permissions for organization resources) and Member (view-only permissions for team resources). A user can be assigned to multiple teams with different roles.
-
-### Can a user have both organization and team roles?
-
-Yes, users can have both organization-level and team-level roles simultaneously. For example, a user can be an organization Member for organization-wide access while also being a Team Leader for a specific team, granting them edit access to that team's resources.
-
-### What resources can be controlled with Grepr permissions?
-
-Grepr permissions can control access to: organization settings, integrations (observability and storage), jobs, users, teams, templates, and datasets. Each resource can have view or edit permissions assigned at organization or team scope.
-
-### What permissions does an Organization Admin have?
-
-Organization Admins have full control over all resources in the organization, including all team-scoped resources. They can create, edit, and delete any resource, manage users, configure organization settings, and manage all integrations and datasets.
-
-### What permissions does an Organization Member have?
-
-Organization Members have view permissions to all resources in the organization, plus write permission on integrations so they can run backfill jobs. They can view integrations, datasets, jobs, users, and teams and write data through any vendor integration, but cannot create, edit, or delete any resources at the organization level.
-
-### What permissions does an Organization Reader have?
-
-Organization Readers have view-only permissions to all resources in the organization and can query logs. Readers cannot create, edit, or delete any resources, and cannot run backfill jobs that send data to a vendor integration. Use the Reader role for users who need to investigate data without incurring vendor write costs.
-
-### What permissions does a Team Leader have?
-
-Team Leaders have edit permissions for all resources scoped to their specific team(s), including creating and editing jobs, integrations, templates, and datasets. They can also view all organization resources but can only edit resources scoped to their team. Team Leaders can also manage team members.
-
-### What permissions does a Team Member have?
-
-Team Members have view permissions to resources scoped to their team, plus write permission on integrations assigned to the team so they can run backfill jobs. They can view jobs, integrations, templates, and datasets assigned to the team, query logs, and run backfills to team integrations, but cannot create or edit any resources.
-
-### What is a custom role in Grepr?
-
-Custom roles allow you to create roles with a specific subset of Grepr platform permissions tailored to your organization's needs. Instead of using standard roles, you can create custom roles like 'Developer' with permissions such as 'view all jobs' and 'edit templates' to match your team's responsibilities and access requirements.

package/build/dist/docs-index/0f1c7ab0-28a3-4a5b-98eb-c0aa8ca55117.txt

@@ -1,91 +0,0 @@
-Reduce log volume using Grepr's intelligent pattern detection, clustering, and sampling for cost-effective observability at scale.
-
-# Reduce noise and improve the usability of your logs with the log reducer
-
-Grepr's log reducer uses clustering algorithms and real-time pattern discovery to identify repeated messages in high-volume log streams and aggregate those messages into summarized events. These summarized events reduce the volume of redundant, low-value log events while retaining full context for less common and often higher-value events.
-
-The log reducer is a core step in a Grepr log reduction pipeline, where it runs after log events have been processed by the parsing, filtering, and transformation steps and before they are sent to your configured sinks. By sending summarized events rather than the full set of logs to your observability vendor, Grepr significantly reduces the volume of shipped logs and your observability costs.
-
-Messages that do not match any pattern pass through unmodified. You can also configure *exceptions* for specific messages or patterns that must bypass the reducer and be forwarded unmodified to your observability platform. See [Bypass aggregation of important messages with exceptions](/transforms/reducer/exceptions).
-
-Log reduction pipelines also persist your unaggregated raw logs in a Grepr data lake, ensuring you maintain full access to your log data while dramatically reducing storage and processing costs. The data lake allows you to query and analyze your raw logs, for example, when an incident occurs or alerts are raised that require access to the full set of logs for troubleshooting or debugging. See [The Grepr data lake](/grepr-platform/data-lake).
-
-When you create a log reduction pipeline, a reducer is added with default settings suitable for many log processing flows. When needed, you can change the configuration settings to meet your requirements. You can modify reducer settings in the UI or through the Grepr REST API. To configure the reducer in the UI, see [Configure the log reducer in a Grepr pipeline](/transforms/reducer/configuration). For API documentation, see the [LogReducer API specification](/apis/api-spec#schema/LogReducer).
-
-## How log reduction works
-
-The log reducer divides incoming log events into fixed-duration, tumbling windows and produces summaries separately for each window. The reducer creates the summarized events through a multi-step process, including transformations to:
-
-* Normalize fields to help group values that represent the same entity but might differ slightly in format or content.
-* Structure messages to optimize grouping.
-* Group messages using similarity metrics.
-* Output a configurable number of raw sample messages per pattern before summarizing additional matches.
-* Create and output a concise summary of aggregated messages that match an identified pattern along with a configurable sample of raw messages. The summarized events include metadata that provides important context about the aggregated messages and preserves important fields. See [Summary message metadata](#summary-metadata).
-* Add a tag to all output events to indicate whether the type of message it contains is a sample, summary, passthrough, or exception. See [Message types](#message-types).
-
-If the reducer cannot find a matching pattern for a message, the message passes through unmodified. Reasons that the reducer cannot find a pattern include:
-
-* The clustering process is unable to extract patterns from messages.
-* The log message field is empty or null.
-* The message matches a configured exception rule that prevents it from being reduced.
-
-To learn more about the transformations the reducer applies to messages and how to modify its default behavior, see [Configure the log reducer in a Grepr pipeline](/transforms/reducer/configuration).
-
-## Example: Summarizing repeated and low-value messages
-
-The following image shows an example of a message that's logged repeatedly but provides little to no value because the service it reports on is intentionally left non-running.
-
-The log reducer identifies the pattern in this message and summarizes it into a single message indicating how many times the original message was logged. The summary also includes other metadata about the pattern and the messages that matched it. Important fields from the original messages are included in the summary. The reducer then outputs this summarized message and a sample of the raw messages.
-
-Viewing the summary message shows the added metadata, such as the number of times the message was logged and the start and end times of the messages that were summarized.
-
-## Summary message metadata \[#summary-metadata]
-
-When the reducer generates a summary message for a pattern, it adds the following metadata fields to the output event that provide important context about the aggregated messages. This metadata allows you to understand the pattern's characteristics and the messages it represents, and to link back to the original raw messages if needed.
-
-| Field | Description |
-| --- | --- |
-| `grepr.patternId` | Unique identifier for the pattern. Use this to find related messages. |
-| `grepr.rawLogsUrl` | A direct link to view all raw messages for this pattern in the Grepr data lake. |
-| `grepr.repeatCount` | The number of input messages included in the summary. This can be useful for metrics and [rewriting queries](/transforms/reducer/exceptions#rewrite-queries). |
-| `grepr.receivedTimestamp` | Milliseconds since the Unix epoch when the summary was emitted by Grepr. |
-| `grepr.firstTimeTimestamp` | Milliseconds since the Unix epoch of the first message in this summary. |
-| `grepr.lastTimeTimestamp` | Milliseconds since the Unix epoch of the last message in this summary. |
-
-## Message types \[#message-types]
-
-After processing, each record is assigned a message type, and the `grepr.messagetype` tag is added to output events with one of the following values:
-
-| Value | Description |
-| --- | --- |
-| `sample` | The message is a sample of the original log messages that matched a specific pattern. Sample messages are sent through unmodified until the deduplication threshold is reached. |
-| `summary` | The message summarizes multiple source log messages that matched a specific pattern. Summary messages are generated at the end of each aggregation window for patterns that have exceeded the deduplication threshold. |
-| `passthrough` | The message did not match any existing patterns and was sent through unmodified. |
-| `exception` | The message matched an exception rule and was sent through unmodified. |
-
-## Next steps
-
-* To modify the reducer's default settings to provide further control over how messages are processed, see [Configure the log reducer in a Grepr pipeline](/transforms/reducer/configuration).
-* If you have important messages that must be forwarded to your observability platform without aggregation, configure *exceptions* to ensure these messages skip the reducer step and are forwarded unchanged. See [Bypass aggregation of important messages with exceptions](/transforms/reducer/exceptions).
-
-## Frequently Asked Questions
-
-### What is log reduction in Grepr?
-
-Log reduction is Grepr's process of identifying patterns in high-volume log streams and aggregating similar messages into concise summaries. This reduces the volume of logs shipped to your observability vendor while preserving access to the underlying raw messages through the Grepr data lake.
-
-### How does Grepr identify log patterns?
-
-The reducer applies a multi-step process to each log message. It normalizes variable values such as timestamps, IDs, and IP addresses, structures the message to optimize grouping, and groups messages into patterns using similarity metrics. For each pattern, the reducer forwards a configurable number of raw sample messages before it summarizes additional matches into a single summary event.
-
-### What does the grepr.messagetype tag indicate?
-
-The grepr.messagetype tag records how a message was processed. The value 'sample' means the message was forwarded before the deduplication threshold was reached, 'summary' means the message is a summary of aggregated messages, 'passthrough' means the message did not match any pattern, and 'exception' means the message matched a configured exception.
-
-### What information does a summary message include?
-
-Each summary message includes grepr.patternId for pattern identification, grepr.repeatCount for the count of input messages aggregated, grepr.firstTimeTimestamp and grepr.lastTimeTimestamp for the first and last message timestamps in the summary, grepr.receivedTimestamp for when the summary was emitted, and grepr.rawLogsUrl for a direct link to the raw messages in the Grepr data lake.
-
-### Why might a message pass through without being aggregated?
-
-A message passes through unmodified when the clustering process can't find a pattern that matches it, when the log message field is empty or null, or when the message matches a configured exception rule that prevents aggregation.