Skip to content
Draft
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
229 changes: 229 additions & 0 deletions docs/changelog.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,229 @@
# Changelog Configuration
# This file configures the valid values for changelog fields using the pivot structure.
# Place this file as `changelog.yml` in the `docs/` directory
#
# NOTE: All list-like fields accept BOTH forms:
# - Comma-separated string: "value1, value2, value3"
# - YAML list:
# - value1
# - value2
# - value3
# Both forms produce the same result. Choose whichever is more readable for your use case.

# Filename strategy for generated changelog files.
# Controls how files created by 'changelog add' are named.
# pr — use the PR number (e.g., 12345.yaml).
# issue — use the issue number (e.g., 67890.yaml).
# timestamp — use a Unix timestamp with a title slug (e.g., 1735689600-fix-search.yaml). Default.
# Can be overridden per invocation with --use-pr-number or --use-issue-number CLI flags.
filename: pr

# Products configuration (optional)
# If not specified, all products from products.yml are allowed (including those
# that have 'public-reference' disabled).
products:
# List of available product IDs (empty = all from products.yml)
available:
- logstash
# Default products when --products not specified
default:
- product: logstash
# lifecycle: ga

# Extraction configuration
# Controls automatic extraction of information from PR descriptions
extract:
# Auto-extract release notes from PR descriptions (default: true)
# Can be overridden by CLI --no-extract-release-notes
release_notes: true
# Auto-extract issues from PR body (default: true)
# Looks for patterns like "Fixes #123", "Closes #456", etc.
issues: true
# Remove square-bracket prefixes from PR titles (default: false)
# When enabled (true or via --strip-title-prefix), titles like "[ES|QL] Fix bug" become "Fix bug".
strip_title_prefix: true

# Available lifecycle values (strongly typed: preview, beta, ga)
lifecycles:
- preview
- beta
- ga

# Pivot configuration for types, subtypes, and areas with label mappings.
# By default we render entries grouped by type > subtype > area.
# NOTE: subtype and area are optional and either may be omitted.
# Labels are specified in a "label -> value" format
pivot:
# Type definitions with optional labels
# At a minimum, feature, bug-fix, and breaking-change must be configured.
# Keys are type names, values can be:
# - simple string: comma-separated label list (e.g., ">bug, >fix")
# - empty/null: no labels for this type
# - object: { labels: "...", subtypes: {...} } for breaking-change type only
types:
# Complex object form with subtypes (ONLY allowed for breaking-change)
# Subtypes help categorize breaking changes by their nature
breaking-change:
labels: "breaking change"
# subtypes:
# api: ">api-breaking"
# behavioral: ">behavioral-breaking"
# configuration: ">config-breaking"
# dependency: ">dependency-breaking"
# subscription: ">subscription-breaking"
# plugin: ">plugin-breaking"
# security: ">security-breaking"
# other:
# Simple string form: labels as comma-separated string
bug-fix: ">bug, bug"
deprecation: "deprecation"
feature:
enhancement: "enhancement"
docs: "docs"
known-issue:
other:
regression: "regression"
security:

# Area definitions with labels
# Keys are area display names, values are label strings
# Multiple labels can be comma-separated
areas:
# Example mappings - customize based on your label naming conventions
# Elasticsearch Output:
# Search: ":Search/Search"
# Security: ":Security/Security"
# Watcher: ":Data Management/Watcher"

# Product definitions with labels (optional).
# Keys are product spec strings; values are label strings or lists that trigger that product.
# A product spec string is: "<product-id> [<target-version>] [<lifecycle>]"
# - Product ID only: "elasticsearch"
# - Product + target: "kibana 9.2.0"
# - Full spec: "cloud-serverless 2025-06 ga"
# When a PR has labels matching any product entry, all matching products are added.
# Precedence: --products CLI option > pivot.products label mapping > products.default > repo inference.
#
# products:
# 'elasticsearch':
# - ":stack/elasticsearch"
# 'kibana':
# - ":stack/kibana"
# 'cloud-serverless':
# - ":cloud/serverless"
# # Specify a target version if known:
# # 'elasticsearch 9.2.0':
# # - ":feature/new-in-9.2"

# Rules configuration — controls which PRs create changelogs and which changelogs are published.
# All list-like fields (exclude, include, exclude_types) accept BOTH forms:
# - Comma-separated string: "value1, value2, value3"
# - YAML list: [value1, value2, value3]
#
# For details and examples, refer to the [rules documentation](https://github.com/elastic/docs-builder/blob/main/docs/contribute/configure-changelogs-ref.md#rules).
rules:
# match: any

# Create — controls which PRs generate changelogs.
# create:
# exclude: ">non-issue, >test"
# # Or equivalently:
# # exclude:
# # - ">non-issue"
# # - ">test"
# # match: any
# products:
# 'elasticsearch, kibana':
# exclude: ">test"
# 'cloud-serverless':
# exclude: "ILM"

# Bundle — filtering applied during 'changelog bundle' and 'changelog gh-release'.
# See https://github.com/elastic/docs-builder/blob/main/docs/contribute/configure-changelogs-ref.md#rules-bundle for Mode 1 / 2 / 3 behavior.
#
# Mode 2 (global content): use global lists only — no `products` key, or `products: {}`.
# Example — include changelogs that list elasticsearch OR kibana (evaluated per changelog):
# bundle:
# match_products: any
# include_products:
# - elasticsearch
# - kibana
# exclude_types: "deprecation, known-issue"
#
# Example — exclude only when the changelog lists BOTH products (conjunction); extras allowed:
# bundle:
# match_products: conjunction
# exclude_products:
# - kibana
# - observability
#
# Mode 3 (per-product context): non-empty `rules.bundle.products` — global include/exclude/type/area
# under `bundle:` are NOT applied for filtering; configure filters under each product key.
# Example:
# bundle:
# exclude_types: [docs] # ignored for filtering in Mode 3 — duplicate under each product if needed
# products:
# observability:
# exclude_products: ["cloud-enterprise"]
# exclude_types: ["docs"]
# include_areas:
# - "APM"
# - "Infrastructure monitoring"
# kibana:
# match_products: all
# include_products: ["kibana", "security"]
# exclude_types: ["docs"]

# Bundle configuration (profiles and defaults)
bundle:
# Input directory containing changelog YAML files
directory: docs/changelog
# Output directory for bundled changelog files
output_directory: docs/releases
# Whether to resolve (copy contents) by default
resolve: true
# description: |
# This release includes new features and bug fixes.
# To allow cross-repo links, add more owner/repo entries.
link_allow_repos:
- elastic/beats
- elastic/elasticsearch
- elastic/kibana
- elastic/logstash
# - elastic/logstash-docs
# - logstash-plugins/logstash-output-elasticsearch
- elastic/roadmap
# Optional: default GitHub repo name applied to all profiles that do not specify their own.
repo: logstash
# Optional: default GitHub owner applied to all profiles that do not specify their own.
owner: elastic
# Optional: control auto-population of release-date for all profiles by default.
# release_dates: true

# Named bundle profiles for different release scenarios.
# Profiles can be used with both 'changelog bundle' and 'changelog remove':
# docs-builder changelog bundle elasticsearch-release 9.2.0
# docs-builder changelog remove elasticsearch-release 9.2.0
# When used with 'changelog remove', only the 'products' field is applied.
# The 'output', 'output_products', 'repo', 'owner', and 'hide_features' fields are
# bundle-specific and are ignored for removal.
profiles:
logstash-release:
# Output filename ({version} is substituted at runtime)
output: "logstash-{version}.yaml"
# Override the products array written to the bundle output.
output_products: "logstash {version}"
# # Optional: profile-specific description (overrides bundle.description)
# # description: |
# # Elasticsearch {version} includes:
# # - Performance improvements
# # - Bug fixes and stability enhancements
# #
# # Download the release binaries: https://github.com/{owner}/{repo}/releases/tag/v{version}
# # Optional: control auto-population of release-date for this profile.
# # When true (default), auto-populate release dates. When false, equivalent to --no-release-date.
# # release_dates: true
# # Feature IDs to hide when bundling with this profile (accepts string or list)
# hide_features:
# - feature-flag-1
# - feature-flag-2
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
issues:
- "17838"
type: enhancement
products:
- product: logstash
target: 9.4.0
title: New batch histogram metrics
description: "We've improved visibility of batch sizing batch sizing at a pipeline level by exposing new histogram-type metrics in the`GET /_node/stats` endpoint. These metrics show the distribution of batch sizes in bytes and event-count for the lifetime of the pipeline, as well as for the most recent 1, 5, and 15-minute time windows."
93 changes: 93 additions & 0 deletions docs/changelog/18265.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,93 @@
##### Required fields #####

# title:
# A required string that is a short, user-facing headline.
# (Max 80 characters)

# type:
# A required string that contains the type of change
# It can be one of:
# - breaking-change
# - bug-fix
# - deprecation
# - feature
# - enhancement
# - docs
# - known-issue
# - other
# - regression
# - security

# products:
# A required array of objects that denote the affected products
# Each product object contains:
#
# - product:
# A required string with a valid product ID.
# Valid values are defined in https://github.com/elastic/docs-builder/blob/main/config/products.yml
#
# target:
# An optional string with the target version or date.
#
# lifecycle:
# An optional string for new features or enhancements that have a specific availability.
# It can be one of:
# - preview
# - beta
# - ga

##### Optional fields #####

# action:
# An optional string that describes what users must do to mitigate
# the impact of a breaking change or known issue.

# areas:
# An optional array of strings that denotes the parts/components/services
# of the product that are affected.

# description:
# An optional string that provides additional information.
# (Max 600 characters).

# feature-id:
# An optional string to associate a feature or enhanceent with a
# unique feature flag.

# highlight:
# An optional boolean for items that should be included in release
# highlights or the UI to draw user attention.

# impact:
# An optional string that describes how the user's environment is
# affected by a breaking change or known issue.

# issues:
# An optional array of strings that contain the issues that are
# relevant to the PR.

# pr:
# An optional string that contains the pull request number.

# subtype:
# An optional string that applies only to breaking changes.
# It can be one of:
# - api
# - behavioral
# - configuration
# - dependency
# - subscription
# - plugin
# - security
# - other

pr: "18265"
issues:
- https://github.com/elastic/logstash/issues/17980
- https://github.com/elastic/logstash/issues/18078
type: bug-fix
products:
- product: logstash
target: 9.3.0
title: 'management: confirm server-side filtering 404s'
description: fixes an issue with Central Management where a spurious 404 when looking up pipeline definitions could cause the running pipelines to shut down.
Loading
Loading