Skip to content

Commit

Permalink
feat: fail flag for checks (#61)
Browse files Browse the repository at this point in the history 
- added a flag for checks. When this flag is set to true, if any of the
checks fail, the app will return a failure status.
- added column is_critical for check and check_load in results storage
  • Loading branch information
@dmrmlvv
dmrmlvv authored Oct 18, 2024
1 parent bdedfad commit cf32cbd
Show file tree
Hide file tree
Showing 24 changed files with 723 additions and 19 deletions.
102 changes: 102 additions & 0 deletions checkita-core/src/main/resources/db/specific/h2/V1.7__add_is_critical_column.sql
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,102 @@
ALTER TABLE "${defaultSchema}"."results_check" RENAME TO "results_check_backup";
CREATE TABLE "${defaultSchema}"."results_check"
(
"job_id" VARCHAR(512) NOT NULL,
"check_id" VARCHAR(512) NOT NULL,
"check_name" VARCHAR(512) NOT NULL,
"description" TEXT,
"metadata" TEXT,
"source_id" VARCHAR(512) NOT NULL,
"base_metric" VARCHAR(512) NOT NULL,
"compared_metric" VARCHAR(512),
"compared_threshold" DOUBLE PRECISION,
"lower_bound" DOUBLE PRECISION,
"upper_bound" DOUBLE PRECISION,
"status" VARCHAR(512) NOT NULL,
"message" TEXT,
"is_critical" BOOLEAN NOT NULL,
"reference_date" TIMESTAMP NOT NULL,
"execution_date" TIMESTAMP NOT NULL,
UNIQUE ("job_id", "check_id", "reference_date")
);
INSERT INTO "${defaultSchema}"."results_check" (
"job_id",
"check_id",
"check_name",
"description",
"metadata",
"source_id",
"base_metric",
"compared_metric",
"compared_threshold",
"lower_bound",
"upper_bound",
"status",
"message",
"is_critical",
"reference_date",
"execution_date"
) SELECT "job_id",
"check_id",
"check_name",
"description",
"metadata",
"source_id",
"base_metric",
"compared_metric",
"compared_threshold",
"lower_bound",
"upper_bound",
"status",
"message",
false,
"reference_date",
"execution_date"
FROM "${defaultSchema}"."results_check_backup";
DROP TABLE "${defaultSchema}"."results_check_backup";


ALTER TABLE "${defaultSchema}"."results_check_load" RENAME TO "results_check_load_backup";
CREATE TABLE "${defaultSchema}"."results_check_load"
(
"job_id" VARCHAR(512) NOT NULL,
"check_id" VARCHAR(512) NOT NULL,
"check_name" VARCHAR(512) NOT NULL,
"description" VARCHAR(512),
"metadata" TEXT,
"source_id" VARCHAR(512) NOT NULL,
"expected" VARCHAR(512) NOT NULL,
"status" VARCHAR(512) NOT NULL,
"message" TEXT,
"is_critical" BOOLEAN NOT NULL,
"reference_date" TIMESTAMP NOT NULL,
"execution_date" TIMESTAMP NOT NULL,
UNIQUE ("job_id", "check_id", "reference_date")
);
INSERT INTO "${defaultSchema}"."results_check_load" (
"job_id",
"check_id",
"check_name",
"description",
"metadata",
"source_id",
"expected",
"status",
"message",
"is_critical",
"reference_date",
"execution_date"
) SELECT "job_id",
"check_id",
"check_name",
"description",
"metadata",
"source_id",
"expected",
"status",
"message",
false,
"reference_date",
"execution_date"
FROM "${defaultSchema}"."results_check_load_backup";
DROP TABLE "${defaultSchema}"."results_check_load_backup";
102 changes: 102 additions & 0 deletions checkita-core/src/main/resources/db/specific/mssql/V1.7__add_is_critical_column.sql
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,102 @@
EXEC sp_rename '${defaultSchema}.results_check', 'results_check_backup';
CREATE TABLE "${defaultSchema}"."results_check"
(
"job_id" VARCHAR(512) NOT NULL,
"check_id" VARCHAR(512) NOT NULL,
"check_name" VARCHAR(512) NOT NULL,
"description" VARCHAR(MAX),
"metadata" VARCHAR(MAX),
"source_id" VARCHAR(512) NOT NULL,
"base_metric" VARCHAR(512) NOT NULL,
"compared_metric" VARCHAR(512),
"compared_threshold" DOUBLE PRECISION,
"lower_bound" DOUBLE PRECISION,
"upper_bound" DOUBLE PRECISION,
"status" VARCHAR(512) NOT NULL,
"message" VARCHAR(MAX),
"is_critical" BIT NOT NULL,
"reference_date" DATETIME NOT NULL,
"execution_date" DATETIME NOT NULL,
UNIQUE ("job_id", "check_id", "reference_date")
);
INSERT INTO "${defaultSchema}"."results_check" (
"job_id",
"check_id",
"check_name",
"description",
"metadata",
"source_id",
"base_metric",
"compared_metric",
"compared_threshold",
"lower_bound",
"upper_bound",
"status",
"message",
"is_critical",
"reference_date",
"execution_date"
) SELECT "job_id",
"check_id",
"check_name",
"description",
"metadata",
"source_id",
"base_metric",
"compared_metric",
"compared_threshold",
"lower_bound",
"upper_bound",
"status",
"message",
false,
"reference_date",
"execution_date"
FROM "${defaultSchema}"."results_check_backup";
DROP TABLE "${defaultSchema}"."results_check_backup";


EXEC sp_rename '${defaultSchema}.results_check_load', 'results_check_load_backup';
CREATE TABLE "${defaultSchema}"."results_check_load"
(
"job_id" VARCHAR(512) NOT NULL,
"check_id" VARCHAR(512) NOT NULL,
"check_name" VARCHAR(512) NOT NULL,
"description" VARCHAR(MAX),
"metadata" VARCHAR(MAX),
"source_id" VARCHAR(512) NOT NULL,
"expected" VARCHAR(512) NOT NULL,
"status" VARCHAR(512) NOT NULL,
"message" VARCHAR(MAX),
"is_critical" BIT NOT NULL,
"reference_date" DATETIME NOT NULL,
"execution_date" DATETIME NOT NULL,
UNIQUE ("job_id", "check_id", "reference_date")
);
INSERT INTO "${defaultSchema}"."results_check_load" (
"job_id",
"check_id",
"check_name",
"description",
"metadata",
"source_id",
"expected",
"status",
"message",
"is_critical",
"reference_date",
"execution_date"
) SELECT "job_id",
"check_id",
"check_name",
"description",
"metadata",
"source_id",
"expected",
"status",
"message",
false,
"reference_date",
"execution_date"
FROM "${defaultSchema}"."results_check_load_backup";
DROP TABLE "${defaultSchema}"."results_check_load_backup";
108 changes: 108 additions & 0 deletions checkita-core/src/main/resources/db/specific/mysql/V1.7__add_is_critical_column.sql
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,108 @@
/*
We have to limit number of bytes used for job_id, metric_id and check_id by limiting maximum number of chars to 256.
This is required because these fields are used to build unique index and MySQL limits total size of the key
in index by 3072 bytes. We cannot reduce size of timestamp field, therefore, have to limit number of chars
in text fields.
*/
ALTER TABLE "${defaultSchema}"."results_check" RENAME TO "results_check_backup";
CREATE TABLE "${defaultSchema}"."results_check"
(
"job_id" VARCHAR(256) NOT NULL,
"check_id" VARCHAR(256) NOT NULL,
"check_name" VARCHAR(512) NOT NULL,
"description" TEXT,
"metadata" TEXT,
"source_id" VARCHAR(512) NOT NULL,
"base_metric" VARCHAR(512) NOT NULL,
"compared_metric" VARCHAR(512),
"compared_threshold" DOUBLE PRECISION,
"lower_bound" DOUBLE PRECISION,
"upper_bound" DOUBLE PRECISION,
"status" VARCHAR(512) NOT NULL,
"message" TEXT,
"is_critical" BOOLEAN NOT NULL,
"reference_date" TIMESTAMP NOT NULL,
"execution_date" TIMESTAMP NOT NULL,
UNIQUE ("job_id", "check_id", "reference_date")
);
INSERT INTO "${defaultSchema}"."results_check" (
"job_id",
"check_id",
"check_name",
"description",
"metadata",
"source_id",
"base_metric",
"compared_metric",
"compared_threshold",
"lower_bound",
"upper_bound",
"status",
"message",
"is_critical",
"reference_date",
"execution_date"
) SELECT "job_id",
"check_id",
"check_name",
"description",
"metadata",
"source_id",
"base_metric",
"compared_metric",
"compared_threshold",
"lower_bound",
"upper_bound",
"status",
"message",
false,
"reference_date",
"execution_date"
FROM "${defaultSchema}"."results_check_backup";
DROP TABLE "${defaultSchema}"."results_check_backup";


ALTER TABLE "${defaultSchema}"."results_check_load" RENAME TO "results_check_load_backup";
CREATE TABLE "${defaultSchema}"."results_check_load"
(
"job_id" VARCHAR(256) NOT NULL,
"check_id" VARCHAR(256) NOT NULL,
"check_name" VARCHAR(512) NOT NULL,
"description" TEXT,
"metadata" TEXT,
"source_id" VARCHAR(512) NOT NULL,
"expected" VARCHAR(512) NOT NULL,
"status" VARCHAR(512) NOT NULL,
"message" TEXT,
"is_critical" BOOLEAN NOT NULL,
"reference_date" TIMESTAMP NOT NULL,
"execution_date" TIMESTAMP NOT NULL,
UNIQUE ("job_id", "check_id", "reference_date")
);
INSERT INTO "${defaultSchema}"."results_check_load" (
"job_id",
"check_id",
"check_name",
"description",
"metadata",
"source_id",
"expected",
"status",
"message",
"is_critical",
"reference_date",
"execution_date"
) SELECT "job_id",
"check_id",
"check_name",
"description",
"metadata",
"source_id",
"expected",
"status",
"message",
false,
"reference_date",
"execution_date"
FROM "${defaultSchema}"."results_check_load_backup";
DROP TABLE "${defaultSchema}"."results_check_load_backup";
Loading

0 comments on commit cf32cbd

Please sign in to comment.