hasura/graphql-engine
1
0
Fork 0
mirror of https://github.com/hasura/graphql-engine.git synced 2024-12-14 17:02:49 +03:00
Code Issues Projects Releases Wiki Activity

docs: Update log types

Browse Source 
PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8835
GitOrigin-RevId: 75fb156a8c79bfac362d245889010d76e621e0e9
This commit is contained in:
pranshi06 2023-04-22 00:41:57 +05:30 committed by hasura-bot
parent 0af80b22d3
commit 28c8eb8fd1
1 changed files with 29 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

55
docs/docs/deployment/logging.mdx
View File

@ -55,31 +55,32 @@ The Community Edition log-types that can be enabled/disabled are:
| Log type | Description | Log Level | | Log type | Description | Log Level |
| ---------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------ | | ---------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------ |
| `startup` | Information that is logged during startup | `info` | | `startup` | Information that is logged during startup | `info` |
| `query-log` | Logs: the entire GraphQL query with variables, generated SQL statements (only for database queries, not for mutations/subscriptions or Remote Schema and Action queries), the operation name (if provided in the GraphQL request) | `info` | | `query-log` | Logs the entire GraphQL query with variables, generated SQL statements (only for database queries, not for mutations/subscriptions or Remote Schema and Action queries), and the operation name (if provided in the GraphQL request) | `info` |
| `execution-log` | Logs data-source-specific information generated during the request | `info` | | `execution-log` | Logs data-source-specific information generated during the request | `info` |
| `http-log` | Http access and error logs at the webserver layer (handling GraphQL and Metadata requests) | `info` and `error` | | `http-log` | HTTP access and error logs at the webserver layer (handling GraphQL and Metadata requests) | `info` and `error` |
| `websocket-log` | Websocket events and error logs at the websocket server layer (handling GraphQL requests) | `info` and `error` | | `websocket-log` | Websocket events and error logs at the websocket server layer (handling GraphQL requests) | `info` and `error` |
| `webhook-log` | Logs responses and errors from the authorization webhook (if setup) | `info` and `error` | | `webhook-log` | Logs responses and errors from the authorization webhook (if setup) | `info` and `error` |
| `livequery-poller-log` | Logs information used for subscription metrics calculation | `info` | | `livequery-poller-log` | Logs information for active subscriptions (poller-id, generated SQL, polling time, parameterized query hash, subscription kind, etc.) | `info` |
| `action-handler-log` | Logs information and errors about action handlers | `info` | | `action-handler-log` | Logs information and errors about Action webhook handlers | `info` |
| `data-connector-log` | Logs debugging information communicated by data connectors | `debug` | | `data-connector-log` | Logs debugging information communicated by data connectors | `debug` |
| `jwk-refresh-log` | Logs information and errors about periodic refreshing of JWK | `info` and `error` | | `jwk-refresh-log` | Logs information and errors about periodic refreshing of JWK | `info` and `error` |
The Enterprise Edition log-types that can be enabled/disabled are: The Enterprise Edition log-types that can be enabled/disabled are:
| Log type | Description | Log Level | | Log type | Description | Log Level |
| ------------------------------ | --------------------------------------------------------------------------------------------------- | --------------------------- | | ------------------------------ | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------- |
| `http-response-log` | Logs information about http response | `info` | | `http-response-log` | Logs information about HTTP response | `info` |
| `api-limit-log` | Logs errors in api limit | `error` | | `api-limit-log` | Logs errors in [API limit](/security/api-limits.mdx) | `error` |
| `livequery-poller-log` | Logs information used for subscription metrics calculation | `info` | | `livequery-poller-log` | Logs information for active subscriptions (poller-id, generated sql, polling time, subscriber count, subscription kind, etc.) | `info` |
| `response-caching-log` | Logs response information and errors from query caching | `info`, `error` and `debug` | | `response-caching-log` | Logs response information and errors from [query caching](/caching/overview.mdx) | `info`, `error` and `debug` |
| `tracing-log` | Logs information from tracing span | `info` | | `tracing-log` | Logs information about [tracing spans](/observability/tracing.mdx) | `info` |
| `metrics` | Logs tenant metrics information | `info` | | `metrics` | Logs tenant metrics information | `info` |
| `health-check-log` | Logs information from health check | `info` and `warn` | | `health-check-log` | Logs source Health Check events which includes health status of a data source | `info` and `warn` |
:::info Note :::info Note
Hasura Enterprise Edition supports all Community Edition log-types. Hasura Enterprise Edition supports all Community Edition log-types. However, the Enterprise Edition logs may contain
more information.
::: :::
@ -87,18 +88,20 @@ Hasura Enterprise Edition supports all Community Edition log-types.
Apart from the above, there are other internal log-types which cannot be configured: Apart from the above, there are other internal log-types which cannot be configured:
| Log type | Description | Log Level | | Log type | Description | Log Level |
| ------------------------------ | --------------------------------------------------------------------------------------------------- | ------------------ | | ------------------------------ | -------------------------------------------------------------------------------------------------------------- | ---------------------------- |
| `pg-client` | Logs from the postgres client library | `warn` | | `pg-client` | Logs from the postgres client library | `warn` |
| `metadata` | Logs inconsistent Metadata items | `warn` | | `metadata` | Logs inconsistent Metadata items | `warn` |
| `telemetry-log` | Logs error (if any) while sending out telemetry data | `info` | | `telemetry-log` | Logs error (if any) while sending out telemetry data | `info` |
| `event-trigger` | Logs HTTP responses from the webhook, HTTP exceptions and internal errors | `info` and `error` | | `event-trigger` | Logs HTTP responses from the webhook, HTTP exceptions and internal errors | `info` and `error` |
| `ws-server` | Debug logs from the websocket server, mostly used internally for debugging | `debug` | | `ws-server` | Debug logs from the websocket server, mostly used internally for debugging | `debug` |
| `schema-sync-thread` | Logs internal events, when it detects schema has changed on Postgres and when it reloads the schema | `info` and `error` | | `schema-sync` | Logs internal events, when it detects schema has changed on Postgres and when it reloads the schema | `info` and `error` |
| `health-check-log` | Logs source Health Check events which includes health status of a data source | `info` and `warn` | | `event-trigger-process` | Logs the statistics of events fetched from database for each source | `info` and `warn` |
| `event-trigger-process` | Logs the statistics of events fetched from database for each source | `info` and `warn` | | `scheduled-trigger-process` | Logs the statistics of scheduled and cron events fetched from metadata storage | `info` and `warn` |
| `scheduled-trigger-process` | Logs the statistics of scheduled and cron events fetched from metadata storage | `info` and `warn` | | `cron-event-generator-process` | Logs the cron triggers fetched from metadata storage for events generation | `info` and `warn` |
| `cron-event-generator-process` | Logs the cron triggers fetched from metadata storage for events generation | `info` and `warn` | | `unstructured` | Other important logs from various features in GraphQL Engine like Event Triggers, Subscriptions, Actions, etc. | `info`, `error` and `debug` |
| `scheduled-trigger` | Logs HTTP responses from the webhook, HTTP exceptions and internal errors for scheduled and cron events | `info` and `error` |
| `source-catalog-migration` | Logs the information and errors about the blocking queries in a Postgres source during source migration | `info` and `error` |
## Logging levels ## Logging levels