Skip to content

chore: update canary-checker source references #467

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
moshloop merged 4 commits into from
Jan 27, 2026
Merged

chore: update canary-checker source references #467

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
daeb7a6
chore: update canary-checker source references
yashmehrotra Jan 26, 2026
2eea28e
chore: update mission-control source references
yashmehrotra Jan 26, 2026
6851e24
chore: update scraper docs
yashmehrotra Jan 26, 2026
620133a
chore: task fmt
yashmehrotra Jan 26, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions .claude/skills/update-source-references/SKILL.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
For all mdx/md files in @docs/canary-checker/ and @docs/mission-control/ that have `<!-- Source: ... -->` comments pointing to Go source files:
Copy link

@coderabbitai coderabbitai bot Jan 26, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Add a top-level heading as the first line.

Markdownlint MD041 expects the first line to be an H1; start with a # heading before the body text.

As per coding guidelines, run make fmt/make lint to catch this.

🧰 Tools
🪛 markdownlint-cli2 (0.18.1)

1-1: First line in a file should be a top-level heading

(MD041, first-line-heading, first-line-h1)

🤖 Prompt for AI Agents 
In @.claude/skills/update-source-references/SKILL.md at line 1, Several MDX/MD
files under `@docs/canary-checker/` and `@docs/mission-control/` that contain HTML
source comments like "<!-- Source: ... -->" are missing a top-level H1 and
trigger markdownlint MD041; open each file containing that "<!-- Source:"
pattern and insert a single top-level heading (a line starting with "# ") as the
very first line before any body text, then save and run make fmt and make lint
to verify/style the change.


1. Update the Source comments to use `#StructName` format without line numbers (e.g., `checks.go#HTTPCheck` not `checks.go:117#HTTPCheck`)

2. For each documented struct, compare ALL public fields from the Go source against the documentation and:
- Add any missing fields
- Fix incorrect field names (check json/yaml tags - use the json/yaml tag name, not the Go field name)
- If json/yaml tag differ from each other, warn user
- Fix incorrect schemes/types (e.g., `Duration` vs `int`, `bool` vs `string`)
- Fix incorrect nested structures (check if fields are inline or nested under a parent key)
- Remove fields that don't exist in the Go struct
- For inline embedded structs, verify which fields they provide

3. For \_canary-spec.mdx, ensure all check types from CanarySpec are listed with correct field names matching the json/yaml tags

Pay attention to:

- yaml tags like `yaml:"env"` mean the field name in docs should be `env`, not the Go field name
- Inline embedded structs (e.g., `Connection`, `Description`, `Templatable`) - their fields appear at the same level
- Pointer vs value types for nested structs
- Deprecated fields should be marked as such
- ignore private fields
2 changes: 1 addition & 1 deletion canary-checker/docs/reference/1-alert-manager.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ sidebar_custom_props:

# <Icon name="prometheus">Alertmanager</Icon>

<!-- Source: modules/canary-checker/api/v1/checks.go:576#AlertManagerCheck -->
<!-- Source: modules/canary-checker/api/v1/checks.go#AlertManagerCheck -->

Checks [Prometheus AlertManager](https://prometheus.io/docs/alerting/latest/alertmanager/) for any firing alerts.

Expand Down
2 changes: 1 addition & 1 deletion canary-checker/docs/reference/1-aws-cloudwatch.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ sidebar_custom_props:

# <Icon name="aws-cloudwatch" size={32}> CloudWatch</Icon>

<!-- Source: modules/canary-checker/api/v1/checks.go:221#CloudWatchCheck -->
<!-- Source: modules/canary-checker/api/v1/checks.go#CloudWatchCheck -->

The CloudWatch check monitors the status of CloudWatch alarms in AWS. It can filter alarms by various criteria and supports transforming alarm data for custom health checks.

Expand Down
2 changes: 1 addition & 1 deletion canary-checker/docs/reference/1-aws-config-rule.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ sidebar_custom_props:

# <Icon name="aws-config" /> AWS Config Rule

<!-- Source: modules/canary-checker/api/v1/checks.go:1224#AwsConfigRuleCheck -->
<!-- Source: modules/canary-checker/api/v1/checks.go#AwsConfigRuleCheck -->

Check if any AWS resources are failing AWS config rule checks.

Expand Down
4 changes: 2 additions & 2 deletions canary-checker/docs/reference/1-aws-config.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ sidebar_custom_props:

# <Icon name="aws-config" /> AWS Config

<!-- Source: modules/canary-checker/api/v1/checks.go:1207#AwsConfigCheck -->
<!-- Source: modules/canary-checker/api/v1/checks.go#AwsConfigCheck -->

AWS Config checks

Expand All @@ -16,7 +16,7 @@ AWS Config checks



<HealthCheck name="awsConfigRule" connection="aws" rows={[
<HealthCheck name="awsConfig" connection="aws" rows={[
{
field: "query",
required: true,
Expand Down
7 changes: 6 additions & 1 deletion canary-checker/docs/reference/1-azure-devops.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ sidebar_custom_props:

# <Icon name="azure-devops" /> Azure Devops

<!-- Source: modules/canary-checker/api/v1/checks.go:1511#AzureDevopsCheck -->
<!-- Source: modules/canary-checker/api/v1/checks.go#AzureDevopsCheck -->

Azure Devops checks for healthy pipeline runs.

Expand All @@ -15,6 +15,11 @@ Azure Devops checks for healthy pipeline runs.
```

<HealthCheck name="azureDevops" edition="standard" rows={[
{
field: "connection",
description: "Connection name for Azure DevOps credentials",
scheme: "string"
},
{
field: "organization",
description: "Name of the Azure Organization",
Expand Down
2 changes: 1 addition & 1 deletion canary-checker/docs/reference/1-catalog.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import ResourceSelector from '@site/docs/snippets/\_resource-selector.mdx';

# <Icon name="config-db">Config DB</Icon>

<!-- Source: modules/canary-checker/api/v1/checks.go:847#CatalogCheck -->
<!-- Source: modules/canary-checker/api/v1/checks.go#CatalogCheck -->

Runs a [config-db](https://github.com/flanksource/config-db) query.

Expand Down
5 changes: 3 additions & 2 deletions canary-checker/docs/reference/1-dns.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ sidebar_custom_props:

# <Icon name="dns" /> DNS

<!-- Source: modules/canary-checker/api/v1/checks.go:674#DNSCheck -->
<!-- Source: modules/canary-checker/api/v1/checks.go#DNSCheck -->

Performs queries to a DNS server, typical use cases include:

Expand All @@ -28,7 +28,8 @@ Performs queries to a DNS server, typical use cases include:
{
field: "port",
description: "Port to query DNS server on",
default: "53"
default: "53",
scheme: "int"
},
{
field: "query",
Expand Down
2 changes: 1 addition & 1 deletion canary-checker/docs/reference/1-elasticsearch.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ sidebar_custom_props:

# <Icon name="elasticsearch" /> ElasticSearch

<!-- Source: modules/canary-checker/api/v1/checks.go:518#ElasticsearchCheck -->
<!-- Source: modules/canary-checker/api/v1/checks.go#ElasticsearchCheck -->

This check connects to a specified ElasticSearch database, run a query against it and verify the results.

Expand Down
4 changes: 2 additions & 2 deletions canary-checker/docs/reference/1-exec.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ sidebar_custom_props:

# <Icon name="console" /> Exec

<!-- Source: modules/canary-checker/api/v1/checks.go:1176#ExecCheck -->
<!-- Source: modules/canary-checker/api/v1/checks.go#ExecCheck -->

Executes a bash (Linux) or powershell (Windows) script. The check is considered passing if the script exits with `0`

Expand All @@ -33,7 +33,7 @@ See <CommonLink to="image-variants">Image Variants</CommonLink> for a list of in
{
field: "checkout",
description: "Specify git repository to mount to the exec process",
scheme: "[`[]GitCheckout`](#git-checkout)",
scheme: "[`GitConnection`](#git-checkout)",
},
{
field: "env",
Expand Down
18 changes: 14 additions & 4 deletions canary-checker/docs/reference/1-folder.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ sidebar_custom_props:

# <Icon name="smb" /> Folder

<!-- Source: modules/canary-checker/api/v1/checks.go:1118#FolderCheck -->
<!-- Source: modules/canary-checker/api/v1/checks.go#FolderCheck -->

Checks the contents of a folder for size, age, and count. Folder based checks are useful in a number of scenarios:

Expand All @@ -26,6 +26,11 @@ Checks the contents of a folder for size, age, and count. Folder based checks ar
description: "A local folder path or a remote folder `smb://`, `sftp://`, `s3://` or `gcs://`",
required: true
},
{
field: 'recursive',
description: "When set to true, recursively scans the folder to list all files (symlinks are listed but not traversed)",
scheme: "bool"
},
{ field: 'sftpConnection',description: "Connection details", scheme: "[SFTP](#sftp)" },
{ field: "gcpConnection", description: "Connection details for GCP", scheme: "[GCP](#gcp)" },
{field: "awsConnection", description: "AWS Access credentials", scheme: "[S3](#s3)" },
Expand Down Expand Up @@ -55,14 +60,19 @@ Checks the contents of a folder for size, age, and count. Folder based checks ar
description: "Filter files based on regular expression",
scheme: "regex"
},

{
field: "filter.since",
description: "Filter files created since this time",
scheme: "string"
},
{field: "minCount", description: "The minimum number of files inside the `path`", scheme: "int"},
{field: "maxCount", description: "The maximum number of files inside the `path`, can be used in conjunction with `filter.regex` to detect error files", scheme: "int"},
{field: "minAge", description: "The youngest age a file can be", scheme: "Duration"},
{field: "maxAge", description: "The oldest age a file can be, often used to check for unprocessed files or files that have not been cleaned up", scheme: "Duration"},
{field: "minSize", description: "The minimum file size, can be used to detect backups that did not upload successfully", scheme: "Size"},
{field: "maxSize", description: "The maximum file size", scheme: "Size"}

{field: "maxSize", description: "The maximum file size", scheme: "Size"},
{field: "availableSize", description: "Minimum available size on the filesystem", scheme: "Size"},
{field: "totalSize", description: "Minimum total size of the filesystem", scheme: "Size"}
]}/>


Expand Down
5 changes: 3 additions & 2 deletions canary-checker/docs/reference/1-git.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ sidebar_custom_props:

# <Icon name="git" /> Git

<!-- Source: modules/canary-checker/api/v1/checks.go:829#GitProtocolCheck -->
<!-- Source: modules/canary-checker/api/v1/checks.go#GitHubCheck -->

<Standard />

Expand All @@ -17,6 +17,7 @@ Execute as SQL style query against a github repo using [mergestat-lite](https://
```

<HealthCheck name="github" rows={[
{field: "githubToken", description: "Github Personal Access Token", scheme: 'EnvVar', required: true},
{field: "connection", description: "Connection name for GitHub credentials", scheme: 'string'},
{field: "githubToken", description: "Github Personal Access Token", scheme: 'EnvVar'},
Comment on lines +20 to +21
Copy link

@coderabbitai coderabbitai bot Jan 26, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Capitalize “GitHub” consistently in the token description.

Minor doc polish to match the official product name.

🔧 Suggested edit 
-  {field: "githubToken", description: "Github Personal Access Token", scheme: 'EnvVar'},
+  {field: "githubToken", description: "GitHub Personal Access Token", scheme: 'EnvVar'},
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
{field: "connection", description: "Connection name for GitHub credentials", scheme: 'string'},
{field: "githubToken", description: "Github Personal Access Token", scheme: 'EnvVar'},
{field: "connection", description: "Connection name for GitHub credentials", scheme: 'string'},
{field: "githubToken", description: "GitHub Personal Access Token", scheme: 'EnvVar'},
🧰 Tools
🪛 LanguageTool

[uncategorized] ~21-~21: The official name of this software platform is spelled with a capital “H”.
Context: ... {field: "githubToken", description: "Github Personal Access Token", scheme: 'EnvVar...

(GITHUB)

🤖 Prompt for AI Agents 
In `@canary-checker/docs/reference/1-git.mdx` around lines 20 - 21, Update the
description for the githubToken entry so the product name is capitalized
correctly: change "Github Personal Access Token" to "GitHub Personal Access
Token" in the object with field "githubToken" to ensure consistent
capitalization across docs.

{field: "query", description: "Query to be executed. See [mergestat-lite](https://github.com/mergestat/mergestat-lite) for syntax", scheme: 'string', required: true},
]}/>
6 changes: 3 additions & 3 deletions canary-checker/docs/reference/1-http.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ sidebar_custom_props:

# <Icon name="http"/> HTTP

<!-- Source: modules/canary-checker/api/v1/checks.go:116#HTTPCheck -->
<!-- Source: modules/canary-checker/api/v1/checks.go#HTTPCheck -->

This check performs queries on HTTP to monitor their activity.

Expand All @@ -30,7 +30,7 @@ This check performs queries on HTTP to monitor their activity.
{field: "responseJSONContent", description: "Deprecated: Use expr and jsonpath function", scheme: "JSONCheck", deprecated: true},
{field: "thresholdMillis", description: "Maximum duration in milliseconds for the HTTP request. It will fail the check if it takes longer", default: 5000, scheme: "int"},
{field: "maxSSLExpiry", description: <>Maximum number of days until the SSL Certificate expires<br/>Equivalent to <code>test.expr: sslAge &lt; Age("7d")</code></>, scheme: "int"},
{field: "envVars", description: "Setup environment variables that are accessible while templating", scheme: "[]EnvVar"},
{field: "env", description: "Environment variables that are accessible while templating", scheme: "[]EnvVar"},
Copy link

@coderabbitai coderabbitai bot Jan 26, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Update the Template Body Variables section to use env.
You rename the field to env, but the later section still says envVars and {fields from []envVars}. Make that section match the new field name to avoid confusion.

🤖 Prompt for AI Agents 
In `@canary-checker/docs/reference/1-http.mdx` at line 33, Update the "Template
Body Variables" section to use the renamed field env: replace any occurrences of
envVars with env and change the placeholder {fields from []envVars} to {fields
from []env} so the documentation consistently references the new field name
(ensure strings and example references that mention envVars are updated to env
as well).

{field: "ntlm", description: "When set to true will authenticate using NTLM v1 protocol", scheme: "bool"},
{field: "ntlmv2", description: "When set to true will authenticate using NTLM v2 protocol", scheme: "bool"},
{field: "crawl", description: "Crawl configuration for following links", scheme: "[Crawl](#crawl-configuration)"},
Expand All @@ -43,7 +43,7 @@ This check performs queries on HTTP to monitor their activity.
{field: "ca", description: "PEM encoded certificate of the CA to verify the server certificate", scheme: "EnvVar"},
{field: "cert", description: "PEM encoded client certificate", scheme: "EnvVar"},
{field: "key", description: "PEM encoded client private key", scheme: "EnvVar"},
{field: "handshakeTimeout", description: "Timeout for SSL handshake (defaults to 10 seconds)", scheme: "int"},
{field: "handshakeTimeout", description: "Timeout for SSL handshake (defaults to 10 seconds)", scheme: "Duration"},
{field: "insecureSkipVerify", description: "Controls whether a client verifies the server's certificate chain and host name", scheme: "bool"}
]}/>

Expand Down
2 changes: 1 addition & 1 deletion canary-checker/docs/reference/1-icmp.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ sidebar_custom_props:

# <Icon name="icmp" /> ICMP

<!-- Source: modules/canary-checker/api/v1/checks.go:182#ICMPCheck -->
<!-- Source: modules/canary-checker/api/v1/checks.go#ICMPCheck -->

Performs ICMP (ping) requests for information on ICMP packet loss, duration, and response.

Expand Down
2 changes: 1 addition & 1 deletion canary-checker/docs/reference/1-junit.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ sidebar_custom_props:

# <Icon name="junit" /> JUnit

<!-- Source: modules/canary-checker/api/v1/checks.go:734#JunitCheck -->
<!-- Source: modules/canary-checker/api/v1/checks.go#JunitCheck -->

JUnit check performs a Unit test, parses the JUnit test reports in a container at a specified path as defined in `testResults`.

Expand Down
4 changes: 2 additions & 2 deletions canary-checker/docs/reference/1-kubernetes-resource.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ sidebar_custom_props:

# <Icon name="k8s" /> Kubernetes Resource

<!-- Source: modules/canary-checker/api/v1/checks.go:923#KubernetesResourceCheck -->
<!-- Source: modules/canary-checker/api/v1/checks.go#KubernetesResourceCheck -->

The Kubernetes resource check creates kubernetes resources based on the provided manifests & perform checks on them. Some common use case of this
check would be to see if a service is accessible via the ingress as shown in the example below.
Expand Down Expand Up @@ -97,7 +97,7 @@ check would be to see if a service is accessible via the ingress as shown in the
field: 'disable',
description:
'Disable the default behavior of waiting for resources to be healthy.',
scheme: 'Duration'
scheme: 'bool'
},
{
field: 'delete',
Expand Down
2 changes: 1 addition & 1 deletion canary-checker/docs/reference/1-kubernetes.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import ResourceSelector from '@site/docs/snippets/\_resource-selector.mdx';

# <Icon name="k8s" /> Kubernetes

<!-- Source: modules/canary-checker/api/v1/checks.go:1067#KubernetesCheck -->
<!-- Source: modules/canary-checker/api/v1/checks.go#KubernetesCheck -->

The Kubernetes check performs requests on Kubernetes resources such as Pods to get the desired information.

Expand Down
6 changes: 3 additions & 3 deletions canary-checker/docs/reference/1-ldap.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ sidebar_custom_props:

# <Icon name="ldap" /> LDAP

<!-- Source: modules/canary-checker/api/v1/checks.go:626#LDAPCheck -->
<!-- Source: modules/canary-checker/api/v1/checks.go#LDAPCheck -->

The LDAP check:

Expand All @@ -18,7 +18,7 @@ The LDAP check:
```
<HealthCheck name="ldap" connection="ldap" rows={[
{field: "bindDN", description: "BindDN to use in query", scheme: 'string', required: true},
{field: "userSearch", description: "UserSearch to use in query", scheme: 'string', required: true},

{field: "userSearch", description: "UserSearch to use in query", scheme: 'string'},
{field: "skipTLSVerify", description: "Skip TLS certificate verification", scheme: 'bool'},
]}/>

2 changes: 1 addition & 1 deletion canary-checker/docs/reference/1-mongo.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ sidebar_custom_props:

# <Icon name="mongo" /> MongoDB

<!-- Source: modules/canary-checker/api/v1/checks.go:797#MongoDBCheck -->
<!-- Source: modules/canary-checker/api/v1/checks.go#MongoDBCheck -->

The Mongo check tries to connect to a specified Mongo Database to ensure connectivity.

Expand Down
8 changes: 5 additions & 3 deletions canary-checker/docs/reference/1-pod.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ tags:

# <Icon name="k8s-pod" /> Pod

<!-- Source: modules/canary-checker/api/v1/checks.go:591#PodCheck -->
<!-- Source: modules/canary-checker/api/v1/checks.go#PodCheck -->

The Pod check creates a new pod and verifies that it can be reached via an Ingress

Expand All @@ -31,8 +31,10 @@ The Pod check creates a new pod and verifies that it can be reached via an Ingre
{field: "deadline", description: "Overall deadline for pod check", scheme: 'Duration'},
{field: "httpRetryInterval", description: "Interval between HTTP retries", scheme: 'Duration'},
{field:"ingressName", description: "Name to use for the ingress object that exposes the created pod", scheme: 'string'},
{field: "ingressHost", description: " URL used by the ingress to expose the created pod ", scheme: 'string'},
{field: "priorityClass", description: " Priority class to assign to the created pod", scheme: 'string'}
{field: "ingressHost", description: "URL used by the ingress to expose the created pod", scheme: 'string'},
{field: "ingressClass", description: "Ingress class to use for the ingress object", scheme: 'string'},
{field: "priorityClass", description: "Priority class to assign to the created pod", scheme: 'string'},
{field: "roundRobinNodes", description: "When true, creates pods on different nodes in a round-robin fashion", scheme: 'bool'}


]}/>
Expand Down
2 changes: 1 addition & 1 deletion canary-checker/docs/reference/1-prometheus.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ sidebar_custom_props:

# <Icon name="prometheus" /> Prometheus

<!-- Source: modules/canary-checker/api/v1/checks.go:782#PrometheusCheck -->
<!-- Source: modules/canary-checker/api/v1/checks.go#PrometheusCheck -->

The Prometheus Check connects to the Prometheus host, performs the desired query, and displays the results.

Expand Down
2 changes: 1 addition & 1 deletion canary-checker/docs/reference/1-pubsub.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ sidebar_custom_props:
icon: aws-sqs
---

<!-- Source: modules/canary-checker/api/v1/checks.go:703#PubSubCheck -->
<!-- Source: modules/canary-checker/api/v1/checks.go#PubSubCheck -->

This check connects to a PubSub Queue (SQS, GCP PubSub, RabbitMQ, Kafka, NATs) and pulls messages.

Expand Down
2 changes: 1 addition & 1 deletion canary-checker/docs/reference/1-redis.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ sidebar_custom_props:

# <Icon name="redis" /> Redis

<!-- Source: modules/canary-checker/api/v1/checks.go:372#RedisCheck -->
<!-- Source: modules/canary-checker/api/v1/checks.go#RedisCheck -->

The Redis check connects to a specified Redis database instance to check its availability.

Expand Down
2 changes: 1 addition & 1 deletion canary-checker/docs/reference/1-s3-protocol.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ tags:

# <Icon name="aws-s3" /> S3 Protocol

<!-- Source: modules/canary-checker/api/v1/checks.go:205#S3Check -->
<!-- Source: modules/canary-checker/api/v1/checks.go#S3Check -->

Checks if S3 compatible endpoints (like Minio, EMC ECS) are functioning correctly,

Expand Down
6 changes: 3 additions & 3 deletions canary-checker/docs/reference/1-sql.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import { AzureSqlServer } from "@flanksource/icons/mi"

# <AzureSqlServer/> SQL

<!-- Source: modules/canary-checker/api/v1/checks.go:425#PostgresCheck, 441#MssqlCheck, 469#MysqlCheck -->
<!-- Source: modules/canary-checker/api/v1/checks.go#PostgresCheck, #MssqlCheck, #MysqlCheck -->

This check connects to a specified Postgres database, run a query against it and verify the results.

Expand All @@ -17,8 +17,8 @@ This check connects to a specified Postgres database, run a query against it and

<HealthCheck name="postgres" connection="url" rows={[
{field: "query", description: "Query to execute against the Postgres database", scheme: 'SQL', required: true},
{field: "results", description: "Number of expected rows in results", scheme: 'int'}

{field: "results", description: "Number of expected rows in results", scheme: 'int'},
{field: "timeout", description: "Timeout in seconds for query execution (default: 60)", scheme: 'int'}
]}/>

## Result Variables
Expand Down
2 changes: 1 addition & 1 deletion canary-checker/docs/reference/1-tcp.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ sidebar_custom_props:

# <Icon name="network" /> TCP

<!-- Source: modules/canary-checker/api/v1/checks.go:166#TCPCheck -->
<!-- Source: modules/canary-checker/api/v1/checks.go#TCPCheck -->

Checks if a network port is reachable.

Expand Down
Loading