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

feat(http-log): Add docs for logged header allow list #5984

Closed
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
662 changes: 662 additions & 0 deletions app/_data/docs_nav_gateway_3.5.x.yml

Large diffs are not rendered by default.

14 changes: 14 additions & 0 deletions app/_data/kong_versions.yml
Original file line number Diff line number Diff line change
Expand Up @@ -236,6 +236,20 @@
libyaml: "0.2.5"
pcre: 8.45
lua_doc: true
- release: "3.5.x"
ee-version: "3.5.0.0"
ce-version: "3.5.0"
edition: "gateway"
luarocks_version: "3.0.0-0"
dependencies:
luajit: "2.1-20220411"
luarocks: "3.9.1"
postgres: "9.5+"
openresty: "1.21.4.1"
openssl: "1.1.1.q"
libyaml: "0.2.5"
pcre: 8.45
lua_doc: true
- release: "2.1.x"
version: "2.1"
edition: "getting-started-guide"
Expand Down
105 changes: 105 additions & 0 deletions app/_data/tables/support/gateway/versions/35.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,105 @@
{% include_relative_once _data/tables/support/gateway/packages.yml %}
{% include_relative_once _data/tables/support/gateway/third-party.yml %}
{% include_relative_once _data/tables/support/gateway/browsers.yml %}

lts: false
distributions:
- <<: *amazonlinux2
docker: true
arm: true
graviton: true
- <<: *amazonlinux2023
docker: true
arm: true
graviton: true
- *debian10
- <<: *debian11
docker: true
arm: true
graviton: true
- *rhel7
- <<: *rhel8
docker: false
fips: true
- <<: *rhel9
docker: true
arm: true
fips: true
- <<: *ubuntu2004
arm: false
docker: false
fips: true
- <<: *ubuntu2204
arm: true
graviton: true
docker: true
fips: true

third-party:
datastore:
- <<: *postgres
versions:
- 15
- 14
- 13
- 12
- 11
- 10
- 9
- Amazon RDS
- Amazon Aurora
- *redis
- *influxdb
- *kafka

metrics:
- *prometheus
- *statsd
- *opentelemetry
- *zipkin

vault:
- *vaultproject
- *aws-sm
- *gcp-sm

identity_provider:
- *auth0
- *cognito
- *connect2id
- *curity
- *dex
- *gluu
- *google
- *identityserver
- *keycloak
- *azure-ad
- *microsoft-adfs
- *microsoft-live-connect
- *okta
- *onelogin
- *openam
- *paypal
- *pingfederate
- *salesforce
- *wso2
- *yahoo

service_mesh:
- *kongmesh
- *istio

log_provider:
- *splunk
- *datadog
- *loggly

s3_api:
- *s3
- *minio

browsers:
- *edge
- *chrome
- *firefox
- *safari
23 changes: 23 additions & 0 deletions app/_hub/kong-inc/http-log/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,3 +61,26 @@ The log server that receives these messages might require extra headers, such as
{% include /md/plugins-hub/log_custom_fields_by_lua.md %}

{% endif_plugin_version %}

{% if_plugin_version gte:2.8.x %}

## Logged headers allow list

Some use cases may require that only a set of allowed request and response headers are included in the logs.
This can be to reduce overall log entry size, avoid garbage header values from the end user from being logged, or to avoid non-standard sensitive header values from being logged un-redacted.

The HTTP Log plugin can be configured to enforce an allow list of header names, such that only request or response headers who's name matches an allowed value will be included in the logs.

To enable this functionality, configure the plugin with:

```yaml
...
- name: http-log
config:
enable_logged_header_allow_list: true
...
```

To set the header names in the allow list, configure the `logged_header_allow_list` array. By default, the allow list contains a number of standard request and response headers. For more info, view the configuration reference.

{% endif_plugin_version %}
2 changes: 2 additions & 0 deletions app/_hub/kong-inc/opentelemetry/_changelog.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
## Changelog

**{{site.base_gateway}} 3.5.x**
* Added support for [Google Cloud Project's X-Cloud-Trace-Context header](https://cloud.google.com/trace/docs/setup#force-trace)

**{{site.base_gateway}} 3.4.x**
* Added support for [AWS X-Ray header](https://docs.aws.amazon.com/xray/latest/devguide/xray-concepts.html#xray-concepts-tracingheader) propagation.
Expand Down
3 changes: 3 additions & 0 deletions app/_hub/kong-inc/opentelemetry/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -170,6 +170,9 @@ The OpenTelemetry plugin propagates the following headers:
{% if_plugin_version gte:3.4.x %}
- `aws`: [AWS X-Ray header](https://docs.aws.amazon.com/xray/latest/devguide/xray-concepts.html#xray-concepts-tracingheader)
{% endif_plugin_version %}
{% if_plugin_version gte:3.5.x %}
- `gcp`: [GCP X-Cloud-Trace-Context header](https://cloud.google.com/trace/docs/setup#force-trace)
{% endif_plugin_version %}

The plugin detects the propagation format from the headers and will use the appropriate format to propagate the span context.
If no appropriate format is found, the plugin will fallback to the default format, which is `w3c`.
Expand Down
10 changes: 10 additions & 0 deletions app/_src/gateway/breaking-changes/35x.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: Kong Gateway 3.5.x breaking changes
content_type: reference
---

Before upgrading, review any configuration or breaking changes in this version and prior versions that
affect your current installation.

You may need to adopt different upgrade paths depending on your deployment methods, set of features in use,
custom plugins, for example.
3 changes: 3 additions & 0 deletions app/_src/gateway/support/browser.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,9 @@ breadcrumb: Browser
Kong supports N-1 versions of Edge, Chrome, Firefox and Safari on desktop plus any extended support versions.

{% navtabs %}
{% navtab 3.5 %}
{% include_cached gateway-support-browsers.html data=site.data.tables.support.gateway.versions.35 %}
{% endnavtab %}
{% navtab 3.4 %}
{% include_cached gateway-support-browsers.html data=site.data.tables.support.gateway.versions.34 %}
{% endnavtab %}
Expand Down
3 changes: 3 additions & 0 deletions app/_src/gateway/support/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,9 @@ Customers with platinum or higher subscriptions may request fixes outside of the
Kong supports the following versions of {{site.ee_product_name}}:

{% navtabs %}
{% navtab 3.5 %}
{% include_cached gateway-support.html version="3.5" data=site.data.tables.support.gateway.versions.35 eol="TBD" %}
{% endnavtab %}
{% navtab 3.4 LTS %}
{% include_cached gateway-support.html version="3.4" data=site.data.tables.support.gateway.versions.34 eol="August 2026" %}
{% endnavtab %}
Expand Down
3 changes: 3 additions & 0 deletions app/_src/gateway/support/third-party.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,9 @@ Unless otherwise noted, Kong supports the last 2 versions any third party tool,
> Some third party tools below do not have a version number. These tools are managed services and Kong provides compatibility with the currently released version

{% navtabs %}
{% navtab 3.5 %}
{% include_cached gateway-support-third-party.html data=site.data.tables.support.gateway.versions.35 %}
{% endnavtab %}
{% navtab 3.4 %}
{% include_cached gateway-support-third-party.html data=site.data.tables.support.gateway.versions.34 %}
{% endnavtab %}
Expand Down