CLI for Bigeye

Project description

Bigeye CLI

Version: 0.2.17

Install

Bigeye CLI is a pip installable package. Run the following:

pip install bigeye-cli

Bigeye Credential File Format

Bigeye CLI supports basic authorization and accepts a file in the below format:

{
    "base_url": "https://app.bigeye.com",
    "user": "some_user+some_company@bigeye.com",
    "password": "fakepassword1234"
}

Default Credential

Bigeye supports a default credential file at ~/.bigeye/default_cred.json. To set this up type the following and follow the prompts:

bigeye credential

Credential Environment Variable

Bigeye CLI supports a environment variable for your workspace credential file. Add the following to your ~/.bashrc or ~/.zshrc file:

export BIGEYE_API_CRED_FILE=/some/path/to/bigeye_cred_file.json

Basic Usage

$ bigeye --help

Tab/Auto Completion

Bigeye supports tab/auto completion for many different shells. For example, run:

$ bigeye --install-completion zsh

ZSH Completion

Verify that the following has been added to your shell rc file:

autoload -Uz compinit
zstyle :completion:* menu select
fpath+=~/.zfunc

If you are having trouble with auto complete then add the following below the 3 lines above.

compinit

CLI Documentation

`bigeye workspace`

Workspace Commands for Bigeye CLI

Usage:

$ bigeye workspace [OPTIONS] COMMAND [ARGS]...

Options:

--install-completion: Install completion for the current shell.
--show-completion: Show completion for the current shell, to copy it or customize the installation.
--help: Show this message and exit.

Commands:

schedule-all-metrics: Schedule all metrics in a workspace.
unschedule-all-metrics

`bigeye workspace schedule-all-metrics`

Schedule all metrics in a workspace.

Usage:

$ bigeye workspace schedule-all-metrics [OPTIONS]

Options:

-b, --bigeye_conf TEXT: Bigeye Basic Auth Configuration File
-type, --time_interval_type INTEGER: Time interval type. UNDEFINED_TIME_INTERVAL_TYPE:0 HOURS_TIME_INTERVAL_TYPE:1 MINUTES_TIME_INTERVAL_TYPE:2 SECONDS_TIME_INTERVAL_TYPE:3 DAYS_TIME_INTERVAL_TYPE:4 WEEKDAYS_TIME_INTERVAL_TYPE:5 [default: 1]
-value, --interval_value INTEGER: Number of intervals to set on all metric schedules. If 0 use unschedule all metrics. [required]
--help: Show this message and exit.

`bigeye workspace unschedule-all-metrics`

Usage:

$ bigeye workspace unschedule-all-metrics [OPTIONS]

Options:

-b, --bigeye_conf TEXT: Bigeye Basic Auth Configuration File [required]
--help: Show this message and exit.

`bigeye catalog`

Catalog Commands for Bigeye CLI

Usage:

$ bigeye catalog [OPTIONS] COMMAND [ARGS]...

Options:

--install-completion: Install completion for the current shell.
--show-completion: Show completion for the current shell, to copy it or customize the installation.
--help: Show this message and exit.

Commands:

add-source: Adds a source to specified Bigeye workspace.
backfill-autothresholds: Backfills autothresholds by warehouse id,...
backfill-metrics: Backfills metrics by warehouse id, schema...
delete-metrics: Delete metrics in a warehouse id, by schema...
delete-source: Delete a source from specified Bigeye...
deploy-all-autometrics: Deploys all Autometrics to specified...
get-metric-info: Outputs metric info to a file.
get-metric-queries: Gets the debug queries for all metrics by...
get-table-info: Outputs table info to a file for an entire...
rebuild: Rebuilds/Reprofiles a source by warehouse id...
regen-autometrics: Regenerates Autometrics by warehouse id OR...
run-metrics: Runs metrics by warehouse id, schema names,...
schedule-all-metrics: Updates schedule for all metrics in a...
set-metric-time: Sets metric times from a list of possible...
unset-metric-time: Unsets metric times for whole warehouse or...

`bigeye catalog add-source`

Adds a source to specified Bigeye workspace. Supports either source configs stored in AWS Secrets manager OR locally in file.

Usage:

$ bigeye catalog add-source [OPTIONS]

Options:

-b, --bigeye_conf TEXT: Bigeye Basic Auth Configuration File
-sn, --secret_name TEXT: The name of the secret to retrieve from AWS Secrets Manager
-srn, --secret_region_name TEXT: AWS Secret Manager Region Name [default: us-west-2]
-sccf, --source_catalog_config_file TEXT: The file containing the necessary parameters for adding a source to Bigeye.
--help: Show this message and exit.

`bigeye catalog backfill-autothresholds`

Backfills autothresholds by warehouse id, schema names, and/or table ids.

Usage:

$ bigeye catalog backfill-autothresholds [OPTIONS]

Options:

-b, --bigeye_conf TEXT: Bigeye Basic Auth Configuration File
-wid, --warehouse_id INTEGER: Warehouse ID
-sn, --schema_name TEXT: List of Schema Names. E.g. -sn schema_1 -sn schema_2.
-tid, --table_id INTEGER: Table IDs. E.g. -tid 123 -tid 124
--help: Show this message and exit.

`bigeye catalog backfill-metrics`

Backfills metrics by warehouse id, schema names, and/or table ids.

Usage:

$ bigeye catalog backfill-metrics [OPTIONS]

Options:

-b, --bigeye_conf TEXT: Bigeye Basic Auth Configuration File
-wid, --warehouse_id INTEGER: Warehouse ID
-sn, --schema_name TEXT: List of Schema Names. E.g. -sn schema_1 -sn schema_2.
-tid, --table_id INTEGER: Table IDs. E.g. -tid 123 -tid 124
--help: Show this message and exit.

`bigeye catalog delete-metrics`

Delete metrics in a warehouse id, by schema names, or by table_ids. Also, can filter by multipe metric types.

Usage:

$ bigeye catalog delete-metrics [OPTIONS]

Options:

-b, --bigeye_conf TEXT: Bigeye Basic Auth Configuration File
-wid, --warehouse_id INTEGER: Warehouse ID
-sn, --schema_name TEXT: List of Schema Names. E.g. -sn schema_1 -sn schema_2.
-tid, --table_id INTEGER: Table IDs. E.g. -tid 123 -tid 124
-m, --metric_name TEXT: Predefined Metric Names to filter by.UNDEFINED_PREDEFINED_METRIC_NAME, PERCENT_NULL, COUNT_NULL, PERCENT_EMPTY_STRING, COUNT_EMPTY_STRING, PERCENT_UNIQUE, PERCENT_VALUE_IN_LIST, AVERAGE, MIN, MAX, SUM, COUNT_ROWS, COUNT_DISTINCT, HOURS_SINCE_MAX_DATE, HOURS_SINCE_MAX_TIMESTAMP, COUNT_TRUE, PERCENT_TRUE, COUNT_FALSE, PERCENT_FALSE, COUNT_USA_PHONE, PERCENT_USA_PHONE, COUNT_USA_ZIP_CODE, PERCENT_USA_ZIP_CODE, PERCENT_UUID, COUNT_TIMESTAMP_STRING, PERCENT_TIMESTAMP_STRING, COUNT_DUPLICATES, COUNT_USA_STATE_CODE, PERCENT_USA_STATE_CODE, VARIANCE, SKEW, KURTOSIS, GEOMETRIC_MEAN, HARMONIC_MEAN, COUNT_UUID, COUNT_CUSIP, PERCENT_CUSIP, COUNT_SEDOL, PERCENT_SEDOL, COUNT_ISIN, PERCENT_ISIN, COUNT_LEI, PERCENT_LEI, COUNT_FIGI, PERCENT_FIGI, COUNT_PERM_ID, PERCENT_PERM_ID, COUNT_NAN, PERCENT_NAN, COUNT_LONGITUDE, PERCENT_LONGITUDE, COUNT_LATITUDE, PERCENT_LATITUDE, COUNT_NOT_IN_FUTURE, PERCENT_NOT_IN_FUTURE, COUNT_DATE_NOT_IN_FUTURE, PERCENT_DATE_NOT_IN_FUTURE, MEDIAN, PERCENTILE, COUNT_NOT_NULL, STRING_LENGTH_AVERAGE, STRING_LENGTH_MIN, STRING_LENGTH_MAX, COUNT_SSN, PERCENT_SSN, COUNT_EMAIL, PERCENT_EMAIL, ROWS_INSERTED, HOURS_SINCE_LAST_LOAD, COUNT_READ_QUERIES, PERCENT_NOT_NULL
--help: Show this message and exit.

`bigeye catalog delete-source`

Delete a source from specified Bigeye workspace.

Usage:

$ bigeye catalog delete-source [OPTIONS]

Options:

-b, --bigeye_conf TEXT: Bigeye Basic Auth Configuration File
-wid, --warehouse_id INTEGER: The ID of the warehouse to delete.
--help: Show this message and exit.

`bigeye catalog deploy-all-autometrics`

Deploys all Autometrics to specified warehouse OR warehouse and list of schema names OR warehouse and list of table ids.

Usage:

$ bigeye catalog deploy-all-autometrics [OPTIONS]

Options:

-b, --bigeye_conf TEXT: Bigeye Basic Auth Configuration File [default: /home/ryanwradtke/.bigeye/conf/bigeye_demo.conf]
-wid, --warehouse_id INTEGER: Deploy autometrics to all tables in warehouse.
-sn, --schema_name TEXT: List of Schema Names. E.g. -sn schema_1 -sn schema_2.
-tid, --table_id INTEGER: Table IDs. E.g. -tid 123 -tid 124
-lbd, --lookback_days INTEGER: Look back days for the metrics. [default: 7]
--ops_only: Deploy only operational metrics [default: True]
--help: Show this message and exit.

`bigeye catalog get-metric-info`

Outputs metric info to a file. Includes metric configuration and details about recent runs.

Usage:

$ bigeye catalog get-metric-info [OPTIONS]

Options:

-b, --bigeye_conf TEXT: Bigeye Basic Auth Configuration File
-wid, --warehouse_id INTEGER: Warehouse ID
-sn, --schema_name TEXT: List of Schema Names. E.g. -sn schema_1 -sn schema_2.
-tid, --table_id INTEGER: Table IDs. E.g. -tid 123 -tid 124or schema names.
-ms, --metric_status [HEALTHY|ALERTING|UNKNOWN]: Used to query metric of particular status.
-op, --output_path TEXT: File to write the failed metric configurations to. [required]
--conf_only: Output only the metric configuration. [default: False]
--help: Show this message and exit.

`bigeye catalog get-metric-queries`

Gets the debug queries for all metrics by warehouse id, schema names, or table ids.

Usage:

$ bigeye catalog get-metric-queries [OPTIONS]

Options:

-b, --bigeye_conf TEXT: Bigeye Basic Auth Configuration File
-wid, --warehouse_id INTEGER: Warehouse ID
-sn, --schema_name TEXT: List of Schema Names. E.g. -sn schema_1 -sn schema_2.
-tid, --table_id INTEGER: Table IDs. E.g. -tid 123 -tid 124
-op, --output_path TEXT: File to write the failed metric configurations to. [required]
--help: Show this message and exit.

`bigeye catalog get-table-info`

Outputs table info to a file for an entire warehouse, certain schemas, or certain tables.

Usage:

$ bigeye catalog get-table-info [OPTIONS]

Options:

-b, --bigeye_conf TEXT: Bigeye Basic Auth Configuration File
-wid, --warehouse_id INTEGER: Warehouse ID
-sn, --schema_name TEXT: List of Schema Names. E.g. -sn schema_1 -sn schema_2.
-tid, --table_id INTEGER: Table IDs. E.g. -tid 123 -tid 124
-tn, --table_name TEXT: Table Namess. E.g. -tn some_table -tn some_other_table
-op, --output_path TEXT: File to write the failed metric configurations to. [required]
--help: Show this message and exit.

`bigeye catalog rebuild`

Rebuilds/Reprofiles a source by warehouse id or a schema by warehouse id and schema name.

Usage:

$ bigeye catalog rebuild [OPTIONS]

Options:

-b, --bigeye_conf TEXT: Bigeye Basic Auth Configuration File [default: /home/ryanwradtke/.bigeye/conf/bigeye_demo.conf]
-wid, --warehouse_id INTEGER: Warehouse ID [required]
-sn, --schema_name TEXT: Schema Name
--help: Show this message and exit.

`bigeye catalog regen-autometrics`

Regenerates Autometrics by warehouse id OR warehouse id and list of schema names OR list of table ids.

Usage:

$ bigeye catalog regen-autometrics [OPTIONS]

Options:

-b, --bigeye_conf TEXT: Bigeye Basic Auth Configuration File [default: /home/ryanwradtke/.bigeye/conf/bigeye_demo.conf]
-wid, --warehouse_id INTEGER: Warehouse ID. If none will look for Table IDs. If value then will pull all table ids for warehouse
-sn, --schema_name TEXT: List of Schema Names E.g. -sn schema_1 -sn schema_2. Do not include warehouse name -- GREENE_HOMES_DEMO_STANDARD.CONFORMED is fully qualified and CONFORMED is the schema name.
-tid, --table_id INTEGER: List of Table IDs. E.g. -tid 123 -tid 124
--help: Show this message and exit.

`bigeye catalog run-metrics`

Runs metrics by warehouse id, schema names, and/or table ids

Usage:

$ bigeye catalog run-metrics [OPTIONS]

Options:

-b, --bigeye_conf TEXT: Bigeye Basic Auth Configuration File
-wid, --warehouse_id INTEGER: Warehouse ID
-sn, --schema_name TEXT: List of Schema Names. E.g. -sn schema_1 -sn schema_2.
-tid, --table_id INTEGER: Table IDs. E.g. -tid 123 -tid 124
--help: Show this message and exit.

`bigeye catalog schedule-all-metrics`

Updates schedule for all metrics in a warehouse.

Usage:

$ bigeye catalog schedule-all-metrics [OPTIONS]

Options:

-b, --bigeye_conf TEXT: Bigeye Basic Auth Configuration File
-wid, --warehouse_id INTEGER: Warehouse ID
-type, --time_interval_type INTEGER: Time interval type. UNDEFINED_TIME_INTERVAL_TYPE:0 HOURS_TIME_INTERVAL_TYPE:1 MINUTES_TIME_INTERVAL_TYPE:2 SECONDS_TIME_INTERVAL_TYPE:3 DAYS_TIME_INTERVAL_TYPE:4 WEEKDAYS_TIME_INTERVAL_TYPE:5 [default: 1]
-value, --interval_value INTEGER: Number of intervals to set on all metric schedules. If 0 use unschedule all metrics. [required]
--help: Show this message and exit.

`bigeye catalog set-metric-time`

Sets metric times from a list of possible metric column names. Can set for whole warehouse or for a list of table IDs.

Usage:

$ bigeye catalog set-metric-time [OPTIONS]

Options:

-b, --bigeye_conf TEXT: Bigeye Basic Auth Configuration File
-wid, --warehouse_id INTEGER: Warehouse ID
-tid, --table_id INTEGER: List of table IDs.
-cn, --metric_column_name TEXT: Possible metric column names.. [required]
-r, --replace: replace metric times if already present on tables? Default is false. [default: False]
--help: Show this message and exit.

`bigeye catalog unset-metric-time`

Unsets metric times for whole warehouse or for a list og table IDs.

Usage:

$ bigeye catalog unset-metric-time [OPTIONS]

Options:

-b, --bigeye_conf TEXT: Bigeye Basic Auth Configuration File
-wid, --warehouse_id INTEGER: Warehouse ID
-tid, --table_id INTEGER: List of table IDs.
--help: Show this message and exit.

`bigeye metric`

Metric Commands for Bigeye CLI

Usage:

$ bigeye metric [OPTIONS] COMMAND [ARGS]...

Options:

--install-completion: Install completion for the current shell.
--show-completion: Show completion for the current shell, to copy it or customize the installation.
--help: Show this message and exit.

Commands:

get-info: Outputs metric info to a file.
get-metric-queries: Gets the debug queries for all metrics by...
run: Run metric by id(s)
upsert: Upsert single metric from file.
upsert-from-path: Upsert multiple metrics from files stored in...

`bigeye metric get-info`

Outputs metric info to a file. Includes metric configuration and details about recent runs.

Usage:

$ bigeye metric get-info [OPTIONS]

Options:

-b, --bigeye_conf TEXT: Bigeye Basic Auth Configuration File
-mid, --metric_id INTEGER: Metric Ids. [required]
-ms, --metric_status [HEALTHY|ALERTING|UNKNOWN]: Used to query metric of particular status.
-op, --output_path TEXT: File to write the failed metric configurations to. [required]
--conf_only: Output only the metric configuration. [default: False]
--help: Show this message and exit.

`bigeye metric get-metric-queries`

Gets the debug queries for all metrics by warehouse id, schema names, or table ids.

Usage:

$ bigeye metric get-metric-queries [OPTIONS]

Options:

-b, --bigeye_conf TEXT: Bigeye Basic Auth Configuration File
-mid, --metric_id INTEGER: Metric Ids. [required]
-op, --output_path TEXT: File to write the failed metric configurations to. [required]
--help: Show this message and exit.

`bigeye metric run`

Run metric by id(s)

Usage:

$ bigeye metric run [OPTIONS]

Options:

-b, --bigeye_conf TEXT: Bigeye Basic Auth Configuration File
-mid, --metric_id INTEGER: Metric Ids. [required]
--help: Show this message and exit.

`bigeye metric upsert`

Upsert single metric from file.

Usage:

$ bigeye metric upsert [OPTIONS]

Options:

-b, --bigeye_conf TEXT: Bigeye Basic Auth Configuration File [default: /home/ryanwradtke/.bigeye/conf/bigeye_demo.conf]
-f, --file TEXT: File containing SimpleUpsedrtMetricRequest or MetricConfiguration [required]
-t, --file_type [SIMPLE|FULL]: Metric File Type. Simple conforms to SimpleUpsertMetricRequest and Full conforms to MetricConfiguration [required]
-wid, --warehouse_id INTEGER: (Optional) Warehouse ID. If specified it will reduce the text based search for the table.warehouse
-mid, --metric_id INTEGER: (Optional) Metric Id. If specified it will reduce the text based search for existing metric.
--help: Show this message and exit.

`bigeye metric upsert-from-path`

Upsert multiple metrics from files stored in path.

Usage:

$ bigeye metric upsert-from-path [OPTIONS]

Options:

-b, --bigeye_conf TEXT: Bigeye Basic Auth Configuration File [default: /home/ryanwradtke/.bigeye/conf/bigeye_demo.conf]
-twid, --target_warehouse_id INTEGER: Deploy Metrics to target Warehouse ID. [required]
-sp, --source_path TEXT: Source path file containing the metrics to migrate. [required]
--help: Show this message and exit.

`bigeye issue`

Issues Commands for Bigeye CLI

Usage:

$ bigeye issue [OPTIONS] COMMAND [ARGS]...

Options:

--install-completion: Install completion for the current shell.
--show-completion: Show completion for the current shell, to copy it or customize the installation.
--help: Show this message and exit.

Commands:

get-issues: Gets issues and writes info to files.
update-issue: Updates an issue in Bigeye and returns the...

`bigeye issue get-issues`

Gets issues and writes info to files.

Usage:

$ bigeye issue get-issues [OPTIONS]

Options:

-b, --bigeye_conf TEXT: Bigeye Basic Auth Configuration File
-wid, --warehouse_id INTEGER: Warehouse IDs.
-sn, --schema_name TEXT: Schema names
-mid, --metric_id INTEGER: Metric IDs.
-sla, --sla_id INTEGER: SLA IDs
-iid, --issue_id INTEGER: Issue IDs
-op, --output_path TEXT: File to write the failed metric configurations to. [required]
--help: Show this message and exit.

`bigeye issue update-issue`

Updates an issue in Bigeye and returns the Issue object from the protobuff.

Usage:

$ bigeye issue update-issue [OPTIONS]

Options:

-b, --bigeye_conf TEXT: Bigeye Basic Auth Configuration File
-iid, --issue_id INTEGER: Issue ID [required]
-status, --issue_status TEXT: The status update. Options are ACKNOWLEDGED or CLOSED.
-by, --updated_by TEXT: The user providing the update.
-m, --message TEXT: The message to attach to the issue.
-cl, --closing_label TEXT: Used to train Bigeye when closing an issue. Options are TRUE_POSITIVE, FALSE_POSITIVE, EXPECTED.
--help: Show this message and exit.

`bigeye deltas`

Deltas Commands for Bigeye CLI

Usage:

$ bigeye deltas [OPTIONS] COMMAND [ARGS]...

Options:

--install-completion: Install completion for the current shell.
--show-completion: Show completion for the current shell, to copy it or customize the installation.
--help: Show this message and exit.

Commands:

create-delta: Creates a delta between two tables.
run-delta: Runs a delta by Delta ID.

`bigeye deltas create-delta`

Creates a delta between two tables. Enforces 1:1 column comparisons by case-insensitive column names. Will search and replace by name.

Usage:

$ bigeye deltas create-delta [OPTIONS]

Options:

-b, --bigeye_conf TEXT: Bigeye Basic Auth Configuration File
-n, --delta_name TEXT: Name of delta. [required]
-sid, --source_table_id INTEGER: Source Table ID [required]
-tid, --target_table_id INTEGER: Target Table ID [required]
-m, --metric_name TEXT: List of predefined metric names to enable for the delta. E.g -m SUM -m PERCENT_TRUE UNDEFINED_PREDEFINED_METRIC_NAME, PERCENT_NULL, COUNT_NULL, PERCENT_EMPTY_STRING, COUNT_EMPTY_STRING, PERCENT_UNIQUE, PERCENT_VALUE_IN_LIST, AVERAGE, MIN, MAX, SUM, COUNT_ROWS, COUNT_DISTINCT, HOURS_SINCE_MAX_DATE, HOURS_SINCE_MAX_TIMESTAMP, COUNT_TRUE, PERCENT_TRUE, COUNT_FALSE, PERCENT_FALSE, COUNT_USA_PHONE, PERCENT_USA_PHONE, COUNT_USA_ZIP_CODE, PERCENT_USA_ZIP_CODE, PERCENT_UUID, COUNT_TIMESTAMP_STRING, PERCENT_TIMESTAMP_STRING, COUNT_DUPLICATES, COUNT_USA_STATE_CODE, PERCENT_USA_STATE_CODE, VARIANCE, SKEW, KURTOSIS, GEOMETRIC_MEAN, HARMONIC_MEAN, COUNT_UUID, COUNT_CUSIP, PERCENT_CUSIP, COUNT_SEDOL, PERCENT_SEDOL, COUNT_ISIN, PERCENT_ISIN, COUNT_LEI, PERCENT_LEI, COUNT_FIGI, PERCENT_FIGI, COUNT_PERM_ID, PERCENT_PERM_ID, COUNT_NAN, PERCENT_NAN, COUNT_LONGITUDE, PERCENT_LONGITUDE, COUNT_LATITUDE, PERCENT_LATITUDE, COUNT_NOT_IN_FUTURE, PERCENT_NOT_IN_FUTURE, COUNT_DATE_NOT_IN_FUTURE, PERCENT_DATE_NOT_IN_FUTURE, MEDIAN, PERCENTILE, COUNT_NOT_NULL, STRING_LENGTH_AVERAGE, STRING_LENGTH_MIN, STRING_LENGTH_MAX, COUNT_SSN, PERCENT_SSN, COUNT_EMAIL, PERCENT_EMAIL, ROWS_INSERTED, HOURS_SINCE_LAST_LOAD, COUNT_READ_QUERIES, PERCENT_NOT_NULL
-sf, --source_filter TEXT: Filters to apply to the source table.
-tf, --target_filter TEXT: Filters to apply to the target table.
--help: Show this message and exit.

`bigeye deltas run-delta`

Runs a delta by Delta ID.

Usage:

$ bigeye deltas run-delta [OPTIONS]

Options:

-b, --bigeye_conf TEXT: Bigeye Basic Auth Configuration File
-did, --delta_id INTEGER: Id of delta. [required]
--help: Show this message and exit.

`bieye sla`

SLA Commands for Bigeye CLI

Usage:

$ bieye sla [OPTIONS] COMMAND [ARGS]...

Options:

--install-completion: Install completion for the current shell.
--show-completion: Show completion for the current shell, to copy it or customize the installation.
--help: Show this message and exit.

Commands:

add-metric: Add metric to an SLA.
backfill-metrics: Backfill all metrics in an SLA.
get-metric-info: Get metric info for all metrics in SLA.
get-metric-queries: Gets the debug queries for all metrics by...
migrate-from-json: Loads metrics from SLA oriented metric info...
run-metrics: Run all metrics in an SLA.

`bieye sla add-metric`

Add metric to an SLA.

Usage:

$ bieye sla add-metric [OPTIONS]

Options:

-b, --bigeye_conf TEXT: Bigeye Basic Auth Configuration File [default: /home/ryanwradtke/.bigeye/conf/bigeye_demo.conf]
-mid, --metric_id INTEGER: Metric ID [required]
-sid, --sla_id INTEGER: SLA ID [required]
--help: Show this message and exit.

`bieye sla backfill-metrics`

Backfill all metrics in an SLA.

Usage:

$ bieye sla backfill-metrics [OPTIONS]

Options:

-b, --bigeye_conf TEXT: Bigeye Basic Auth Configuration File [required]
--from_slas: Scrapes all SLAs in customer workspace for Metric Info. [default: False]
--sla_ids INTEGER: SLA IDs. Scrape certain SLAs for Metric Info.
--help: Show this message and exit.

`bieye sla get-metric-info`

Get metric info for all metrics in SLA.

Usage:

$ bieye sla get-metric-info [OPTIONS]

Options:

-b, --bigeye_conf TEXT: Bigeye Basic Auth Configuration File [required]
--from_slas: Scrapes all SLAs in customer workspace for Metric Info. [default: False]
--sla_ids INTEGER: SLA IDs. Scrape certain SLAs for Metric Info.
-op, --output_path TEXT: File to write the failed metric configurations to. [required]
--help: Show this message and exit.

`bieye sla get-metric-queries`

Gets the debug queries for all metrics by warehouse id, schema names, or table ids.

Usage:

$ bieye sla get-metric-queries [OPTIONS]

Options:

-b, --bigeye_conf TEXT: Bigeye Basic Auth Configuration File
-sid, --sla_id INTEGER: SLA ID [required]
-op, --output_path TEXT: File to write the failed metric configurations to. [required]
--help: Show this message and exit.

`bieye sla migrate-from-json`

Loads metrics from SLA oriented metric info output. Used to migrate metrics from one warehouse to another, identical, warehouse

Usage:

$ bieye sla migrate-from-json [OPTIONS]

Options:

-b, --bigeye_conf TEXT: Bigeye Basic Auth Configuration File [required]
-twid, --target_warehouse_id INTEGER: Deploy Metrics to target Warehouse ID. [required]
-ip, --input_path TEXT: Path to read from. [required]
-kn, --keep_notifications: Keep Notifications from versioned or templated metric configuration. [default: False]
-kid, --keep_ids: Keep Metric and SLA IDs from versioned or templated metric configuration. If kept this would update existing metrics and slas. If not kept it would create new. [default: False]
--help: Show this message and exit.

`bieye sla run-metrics`

Run all metrics in an SLA.

Usage:

$ bieye sla run-metrics [OPTIONS]

Options:

-b, --bigeye_conf TEXT: Bigeye Basic Auth Configuration File [default: /home/ryanwradtke/.bigeye/conf/bigeye_demo.conf]
-sid, --sla_id INTEGER: SLA ID [required]
--help: Show this message and exit.

Project details

Release history Release notifications | RSS feed

0.3.66

Oct 23, 2024

0.3.65

Sep 25, 2024

0.3.64

Jul 10, 2024

0.3.63

Jun 7, 2024

0.3.62

Jun 5, 2024

0.3.61

May 23, 2024

0.3.60

May 1, 2024

0.3.55

Mar 19, 2024

0.3.54

Mar 7, 2024

0.3.53

Mar 6, 2024

0.3.52

Feb 12, 2024

0.3.51

Feb 1, 2024

0.3.50

Jan 23, 2024

0.3.47

Nov 15, 2023

0.3.46

Nov 1, 2023

0.3.45

Oct 4, 2023

0.3.44

Sep 22, 2023

0.3.43

Sep 20, 2023

0.3.42

Aug 16, 2023

0.3.41

Aug 7, 2023

0.3.40

Jul 19, 2023

0.3.34

Jul 12, 2023

0.3.33

Jun 14, 2023

0.3.32

May 3, 2023

0.3.31

Apr 26, 2023

0.3.30

Mar 29, 2023

0.3.28

Feb 17, 2023

0.3.27 yanked

Feb 8, 2023

0.3.26

Dec 21, 2022

0.3.25

Nov 15, 2022

0.3.24

Oct 27, 2022

0.3.23

Oct 7, 2022

0.3.22

Oct 6, 2022

0.3.21 yanked

Oct 6, 2022

Reason this release was yanked:

error

0.3.20

Sep 29, 2022

0.3.16

Sep 16, 2022

0.3.15

Sep 12, 2022

0.3.14

Sep 7, 2022

0.3.13

Sep 7, 2022

0.3.12

Sep 7, 2022

0.3.11

Sep 7, 2022

0.3.10

Sep 7, 2022

0.3.9

Sep 6, 2022

0.3.8

Sep 6, 2022

0.3.2 yanked

Aug 16, 2022

Reason this release was yanked:

invalid release

This version

0.2.17

Jun 15, 2022

0.2.16

Jun 10, 2022

0.2.15

Jun 1, 2022

0.2.11

May 25, 2022

0.2.10

May 25, 2022

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

bigeye_cli-0.2.17-py3-none-any.whl (35.9 kB view hashes)

Uploaded Jun 15, 2022 Python 3

Hashes for bigeye_cli-0.2.17-py3-none-any.whl

Hashes for bigeye_cli-0.2.17-py3-none-any.whl
Algorithm	Hash digest
SHA256	`b4eeaae47d5127cc28a4d0c61abba3c9a4b74a1c41e394684c9adb24a244c2ad`
MD5	`aab441e89b01de5af6de4a76e4f63df4`
BLAKE2b-256	`db543dfce9ecdb080d7e4ddb565f6aecc082c81f6339aebc0c5bce80c15e54cc`

bigeye-cli 0.2.17

Navigation

Verified details

Maintainers

Unverified details

Meta

Classifiers

Project description

Bigeye CLI

Install

Bigeye Credential File Format

Default Credential

Credential Environment Variable

Basic Usage

Tab/Auto Completion

ZSH Completion

CLI Documentation

bigeye workspace

bigeye workspace schedule-all-metrics

bigeye workspace unschedule-all-metrics

bigeye catalog

bigeye catalog add-source

bigeye catalog backfill-autothresholds

bigeye catalog backfill-metrics

bigeye catalog delete-metrics

bigeye catalog delete-source

bigeye catalog deploy-all-autometrics

bigeye catalog get-metric-info

bigeye catalog get-metric-queries

bigeye catalog get-table-info

bigeye catalog rebuild

bigeye catalog regen-autometrics

bigeye catalog run-metrics

bigeye catalog schedule-all-metrics

bigeye catalog set-metric-time

bigeye catalog unset-metric-time

bigeye metric

bigeye metric get-info

bigeye metric get-metric-queries

bigeye metric run

bigeye metric upsert

bigeye metric upsert-from-path

bigeye issue

bigeye issue get-issues

bigeye issue update-issue

bigeye deltas

bigeye deltas create-delta

bigeye deltas run-delta

bieye sla

bieye sla add-metric

bieye sla backfill-metrics

bieye sla get-metric-info

bieye sla get-metric-queries

bieye sla migrate-from-json

bieye sla run-metrics

Project details

Verified details

Maintainers

Unverified details

Meta

Classifiers

Release history Release notifications | RSS feed

Download files

Source Distributions

Built Distribution

`bigeye workspace`

`bigeye workspace schedule-all-metrics`

`bigeye workspace unschedule-all-metrics`

`bigeye catalog`

`bigeye catalog add-source`

`bigeye catalog backfill-autothresholds`

`bigeye catalog backfill-metrics`

`bigeye catalog delete-metrics`

`bigeye catalog delete-source`

`bigeye catalog deploy-all-autometrics`

`bigeye catalog get-metric-info`

`bigeye catalog get-metric-queries`

`bigeye catalog get-table-info`

`bigeye catalog rebuild`

`bigeye catalog regen-autometrics`

`bigeye catalog run-metrics`

`bigeye catalog schedule-all-metrics`

`bigeye catalog set-metric-time`

`bigeye catalog unset-metric-time`

`bigeye metric`

`bigeye metric get-info`

`bigeye metric get-metric-queries`

`bigeye metric run`

`bigeye metric upsert`

`bigeye metric upsert-from-path`

`bigeye issue`

`bigeye issue get-issues`

`bigeye issue update-issue`

`bigeye deltas`

`bigeye deltas create-delta`

`bigeye deltas run-delta`

`bieye sla`

`bieye sla add-metric`

`bieye sla backfill-metrics`

`bieye sla get-metric-info`

`bieye sla get-metric-queries`

`bieye sla migrate-from-json`

`bieye sla run-metrics`