Skip to content

Update changelog for version 1.18.0 #1256

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.

Sign up for GitHub

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

Merged
niveathika merged 6 commits into from
Apr 3, 2026
Merged

Update changelog for version 1.18.0 #1256

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
c40b0c4
Update changelog for version 1.18.0
YasanPunch Apr 2, 2026
887d452
Updated with correct issue
YasanPunch Apr 2, 2026
8f06a91
[Automated] Update the native jar versions
YasanPunch Apr 2, 2026
99ea18c
Update specification document to reflect new observability features a…
YasanPunch Apr 2, 2026
6ce5736
Update changelog for version 1.18.0 release
niveathika Apr 3, 2026
e6812b7
Merge branch 'main' into add-observability-metrics-tags
niveathika Apr 3, 2026
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
8 changes: 8 additions & 0 deletions changelog.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,15 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

## [Unreleased]

## [1.18.0] - 2026-04-03

### Added
- [Add observability metrics tags to PostgreSQL client](https://github.com/ballerina-platform/ballerina-library/issues/7763)

## [1.17.0]

### Added

- [Introduce additional Debezium properties](https://github.com/ballerina-platform/ballerina-library/issues/8572)

## [1.16.1] - 2024-06-13
Expand Down
22 changes: 19 additions & 3 deletions docs/spec/spec.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
_Owners_: @daneshk @niveathika
_Reviewers_: @daneshk
_Created_: 2022/01/14
_Updated_: 2022/04/25
_Updated_: 2026/04/02
_Edition_: Swan Lake

## Introduction
Expand All @@ -18,11 +18,13 @@ The conforming implementation of the specification is released to Ballerina cent
## Contents

1. [Overview](#1-overview)
2. [Client](#2-client)
2.1. [Connection Pool Handling](#21-connection-pool-handling)
2. [Client](#2-client)
2.1. [Connection Pool Handling](#21-connection-pool-handling)
2.2. [Closing the Client](#22-closing-the-client)
3. [Queries and Values](#3-queries-and-values)
4. [Database Operations](#4-database-operations)
5. [Observability](#5-observability)
5.1. [Metrics Tags](#51-metrics-tags)

# 1. Overview

Expand Down Expand Up @@ -211,6 +213,20 @@ All the above values are supported as typed `OutParameters` of the `call()` oper

For more information on database operations see the [SQL Specification](https://github.com/ballerina-platform/module-ballerina-sql/blob/master/docs/spec/spec.md#4-database-operations)

# 5. Observability

The PostgreSQL module supports observability through connection pool metrics, reported via the `ballerina/observe` module. The metric names and lifecycle are defined by the `ballerina/sql` module. For more information on connection pool metrics, see the [SQL specification](https://github.com/ballerina-platform/module-ballerina-sql/blob/master/docs/spec/spec.md).

## 6.1. Metric tags

The PostgreSQL module sets the following metric tags on every connection pool it creates. These tags are attached to all pool health and connection event metrics, enabling filtering and identification.

| Tag | Source | Always present | Description |
|---|---|---|---|
| `db_host` | `host` parameter | Yes | Hostname of the MySQL server (defaults to `"localhost"`) |
| `db_port` | `port` parameter | Yes | Port number of the MySQL server (defaults to `3306`) |
| `db_name` | `database` parameter | No | Database name; omitted when `database` is `nil` or empty |

### Change Data Capture Listener

To listen for change data capture (CDC) events from a Postgres database, you must create a [`postgresql:CdcListener`](https://docs.central.ballerina.io/ballerinax/postgresql/latest#CdcListener) object. The listener allows your Ballerina application to react to changes (such as inserts, updates, and deletes) in real time.
Expand Down
Loading