Skip to content
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.

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

Enhance the Config file to include properties for Health Endpoint #2502

Open
sezal98 opened this issue Dec 23, 2024 · 0 comments
Open

Enhance the Config file to include properties for Health Endpoint #2502

sezal98 opened this issue Dec 23, 2024 · 0 comments

Comments

@sezal98
Copy link
Contributor

sezal98 commented Dec 23, 2024

Add additional properties for processing Health Endpoint for datasource, runtime and entities.

Data API builder config

The standard allows for additive data, like DAB config data we could add.

{
  "status": "Healthy",
  "version": "1.2.10",
  "app-name": "dab_oss_1.2.10",
  "dab-configuration": {
    "http": true,
    "https": true,
    "rest": true,
    "graphql": true,
    "telemetry": true,
    "caching": true,
    "mode": "development",
    "dab-configs": [
      "/App/dab-config.json (mssql)"
    ],
    "dab-schemas": [
      "/App/schema.json"
    ]
  }
}

Configuration changes

{
  "runtime" : {
    "health" : {
      "enabled": true, (default: true)
      "cache-ttl": 5, (optional default: 5)
      "max-dop": 5, (optional default: 1)
      "roles": ["anonymous", "authenticated"] (optional default: *)
    }
  }
}
{
  "data-source" : {
    "health" : {
      "moniker": "sqlserver", (optional default: NULL) // not required, on purpose, most have just one
      "enabled": true, (default: true)
      "query": "SELECT TOP 1 1", (option)
      "threshold-ms": 100 (optional default: 10000)
    }
  }
}
{
  "<entity-name>": {
      "health": {
        "enabled": true, (default: true)
        "filter": "Id eq 1" (optional default: null),
        "first": 1 (optional default: 1),
        "threshold-ms": 100 (optional default: 10000)
      },
      ...
    },
  }
}

We want to allow the developer to influence how the checks work against the endpoint/entity.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant