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

update events page #230

Merged
merged 2 commits into from
Jun 20, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion src/concepts/telemetry.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ telemetry:

## Events

Events in Zilla signal important activities and collect relevant information along with them. Primarily they are useful when troubleshooting common issues like model validation or failed secure access, but they provide more observability with the HTTP access information. The easiest way to see logged events in Zilla is to add the [stdout](../reference/config/telemetry/exporters/exporter-stdout.md) exporter to your `zilla.yaml` config.
[Events](../reference/config/telemetry/events.md) in Zilla signal important activities and collect relevant information along with them. Primarily they are useful when troubleshooting common issues like model validation or failed secure access, but they provide more observability with the HTTP and MQTT access information. The easiest way to see logged events in Zilla is to add the [stdout](../reference/config/telemetry/exporters/exporter-stdout.md) exporter to your `zilla.yaml` config.

## Exporters

Expand Down
2 changes: 1 addition & 1 deletion src/reference/config/bindings/binding-mqtt-kafka.md
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ options:

> `string`

Compacted Kafka topic for storing mqtt session states.
Compacted Kafka topic for storing mqtt session states. Cleanup policy must be log compacted.

##### topics.messages\*

Expand Down
110 changes: 68 additions & 42 deletions src/reference/config/telemetry/events.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,17 +14,27 @@ Named events from Zilla that can be exported and logged.
:::: note Event Names

- [BINDING\_HTTP\_REQUEST\_ACCEPTED](#binding-http-request-accepted)
- [BINDING\_KAFKA\_AUTHORIZATION\_FAILED](#binding-kafka-authorization-failed)
- [BINDING\_KAFKA\_API\_VERSION\_REJECTED](#binding-kafka-api-version-rejected)
- [BINDING\_KAFKA\_AUTHORIZATION\_FAILED](#binding-kafka-authorization-failed)
- [BINDING\_MQTT\_CLIENT\_CONNECTED](#binding-mqtt-client-connected)
- [BINDING\_MQTT\_KAFKA\_NON\_COMPACT\_SESSIONS\_TOPIC](#binding-mqtt-kafka-non-compact-sessions-topic)
- [BINDING\_TCP\_DNS\_FAILED](#binding-tcp-dns-failed)
- [BINDING\_TLS\_TLS\_FAILED](#binding-tls-tls-failed)
- [BINDING\_TLS\_PROTOCOL\_REJECTED](#binding-tls-protocol-rejected)
- [BINDING\_TLS\_HANDSHAKE\_FAILED](#binding-tls-handshake-failed)
- [BINDING\_TLS\_KEY\_REJECTED](#binding-tls-key-rejected)
- [BINDING\_TLS\_PEER\_NOT\_VERIFIED](#binding-tls-peer-not-verified)
- [BINDING\_TLS\_HANDSHAKE\_FAILED](#binding-tls-handshake-failed)
- [BINDING\_TLS\_PROTOCOL\_REJECTED](#binding-tls-protocol-rejected)
- [BINDING\_TLS\_TLS\_FAILED](#binding-tls-tls-failed)
- [CATALOG\_APICURIO\_RETRIEVED\_ARTIFACT\_ID](#catalog-apicurio-retrieved-artifact-id)
- [CATALOG\_APICURIO\_RETRIEVED\_ARTIFACT\_SUBJECT\_VERSION](#catalog-apicurio-retrieved-artifact-subject-version)
- [CATALOG\_APICURIO\_UNRETRIEVABLE\_ARTIFACT\_ID](#catalog-apicurio-unretrievable-artifact-id)
- [CATALOG\_APICURIO\_UNRETRIEVABLE\_ARTIFACT\_SUBJECT\_VERSION\_STALE\_ARTIFACT](#catalog-apicurio-unretrievable-artifact-subject-version-stale-artifact)
- [CATALOG\_APICURIO\_UNRETRIEVABLE\_ARTIFACT\_SUBJECT\_VERSION](#catalog-apicurio-unretrievable-artifact-subject-version)
- [CATALOG\_FILESYSTEM\_FILE\_NOT\_FOUND](#catalog-filesystem-file-not-found)
- [CATALOG\_APICURIO\_REMOTE\_ACCESS\_REJECTED](#catalog-apicurio-remote-access-rejected)
- [CATALOG\_KARAPACE\_REMOTE\_ACCESS\_REJECTED](#catalog-karapace-remote-access-rejected)
- [CATALOG\_KARAPACE\_RETRIEVED\_SCHEMA\_ID](#catalog-karapace-retrieved-schema-id)
- [CATALOG\_KARAPACE\_RETRIEVED\_SCHEMA\_SUBJECT\_VERSION](#catalog-karapace-retrieved-schema-subject-version)
- [CATALOG\_KARAPACE\_UNRETRIEVABLE\_SCHEMA\_ID](#catalog-karapace-unretrievable-schema-id)
- [CATALOG\_KARAPACE\_UNRETRIEVABLE\_SCHEMA\_SUBJECT\_VERSION\_STALE\_SCHEMA](#catalog-karapace-unretrievable-schema-subject-version-stale-schema)
- [CATALOG\_KARAPACE\_UNRETRIEVABLE\_SCHEMA\_SUBJECT\_VERSION](#catalog-karapace-unretrievable-schema-subject-version)
- [GUARD\_JWT\_AUTHORIZATION\_FAILED](#guard-jwt-authorization-failed)
- [MODEL\_AVRO\_VALIDATION\_FAILED](#model-avro-validation-failed)
- [MODEL\_CORE\_VALIDATION\_FAILED](#model-core-validation-failed)
Expand All @@ -37,92 +47,108 @@ Named events from Zilla that can be exported and logged.

### BINDING_HTTP_REQUEST_ACCEPTED

> :identity :scheme :method :authority :path
The server received a valid HTTP request.

A successful HTTP request.
### BINDING_KAFKA_API_VERSION_REJECTED

### BINDING_KAFKA_AUTHORIZATION_FAILED
An API version mismatch occurred in the kafka binding.

> :identity
### BINDING_KAFKA_AUTHORIZATION_FAILED

An authorization failure happened in the http, mqtt or the kafka binding.

### BINDING_KAFKA_API_VERSION_REJECTED
### BINDING_MQTT_CLIENT_CONNECTED

> :apiKey :apiVersion
An MQTT session was successfully authorized and connected.

An API version mismatch occurred in the kafka binding.
### BINDING_MQTT_KAFKA_NON_COMPACT_SESSIONS_TOPIC

### BINDING_TCP_DNS_FAILED
The sessions topic declared in the [mqtt-kafka](../bindings/binding-mqtt-kafka.md) is required to be log compacted.

> :address
### BINDING_TCP_DNS_FAILED

A DNS resolution failure.

### BINDING_TLS_TLS_FAILED
### BINDING_TLS_HANDSHAKE_FAILED

A client could not negotiate the desired level of security with the server.

### BINDING_TLS_KEY_REJECTED

A client or server has a misconfiguration of the server or client SSL certificate and private key.

A general `SSLException` occurred.
### BINDING_TLS_PEER_NOT_VERIFIED

A peer's identity could not be verified.

### BINDING_TLS_PROTOCOL_REJECTED

A `SSLProtocolException` occurred.
An error in the operation of the SSL protocol.

### BINDING_TLS_KEY_REJECTED
### BINDING_TLS_TLS_FAILED

A `SSLKeyException` occurred.
A generic error detected by an SSL subsystem.

### BINDING_TLS_PEER_NOT_VERIFIED
### CATALOG_APICURIO_RETRIEVED_ARTIFACT_ID

A `SSLPeerUnverifiedException` occurred.
Fetching the Apicurio artifact was successful.

### BINDING_TLS_HANDSHAKE_FAILED
### CATALOG_APICURIO_RETRIEVED_ARTIFACT_SUBJECT_VERSION

A `SSLHandshakeException` occurred.
Fetching the Apicurio artifact by version was successful.

### CATALOG_FILESYSTEM_FILE_NOT_FOUND
### CATALOG_APICURIO_UNRETRIEVABLE_ARTIFACT_ID

Fetching the Apicurio artifact was unsuccessful.

### CATALOG_APICURIO_UNRETRIEVABLE_ARTIFACT_SUBJECT_VERSION_STALE_ARTIFACT

Fetching the Apicurio artifact by version was unsuccessful, but an previously fetched artifact is still being used.

### CATALOG_APICURIO_UNRETRIEVABLE_ARTIFACT_SUBJECT_VERSION

> :location
Fetching the Apicurio artifact by version was unsuccessful.

### CATALOG_FILESYSTEM_FILE_NOT_FOUND

No file was found at the specified location.

### CATALOG_APICURIO_REMOTE_ACCESS_REJECTED
### CATALOG_KARAPACE_RETRIEVED_SCHEMA_ID

> :method :url :statusCode
Fetching the Karapace schema was successful.

Zilla did not receive a `200` HTTP status code from the Apicurio schema registry catalog. If the status code is `0` the request could not be completed.
### CATALOG_KARAPACE_RETRIEVED_SCHEMA_SUBJECT_VERSION

### CATALOG_KARAPACE_REMOTE_ACCESS_REJECTED
Fetching the Karapace schema by version was successful.

> :method :url :statusCode
### CATALOG_KARAPACE_UNRETRIEVABLE_SCHEMA_ID

Zilla did not receive a `200` HTTP status code from the Apicurio schema registry catalog. If the status code is `0` the request could not be completed.
Fetching the Karapace schema was unsuccessful.

### GUARD_JWT_AUTHORIZATION_FAILED
### CATALOG_KARAPACE_UNRETRIEVABLE_SCHEMA_SUBJECT_VERSION_STALE_SCHEMA

> :identity
Fetching the Karapace schema by version was unsuccessful, but an previously fetched schema is still being used.

### CATALOG_KARAPACE_UNRETRIEVABLE_SCHEMA_SUBJECT_VERSION

Fetching the Karapace schema by version was unsuccessful.

### GUARD_JWT_AUTHORIZATION_FAILED

A client failed authorization for a JWT Guarded route.

### MODEL_AVRO_VALIDATION_FAILED

> :error

A payload did not have the required model schema.

### MODEL_CORE_VALIDATION_FAILED

> :error

A payload did not have the required model schema.

### MODEL_JSON_VALIDATION_FAILED

> :error

A payload did not have the required model schema.

### MODEL_PROTOBUF_VALIDATION_FAILED

> :error

A payload did not have the required model schema.
5 changes: 3 additions & 2 deletions src/reference/config/telemetry/exporters/exporter-syslog.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,18 @@
---
shortTitle: syslog
description: Zilla runtime syslog exporter
icon: aky-zilla-plus
category:
- Telemetry
tag:
- Exporters
---

# Syslog Exporter

[Available in <ZillaPlus/>](https://www.aklivity.io/products/zilla-plus)
{.zilla-plus-badge .hint-container .info}

# Syslog Exporter

Zilla runtime Syslog exporter

```yaml {3}
Expand Down
Loading