> For the complete documentation index, see [llms.txt](https://mariadb.com/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://mariadb.com/docs/maxscale/maxscale-archive/archive/mariadb-maxscale-24-02/maxscale-24-02filters/mariadb-maxscale-2402-maxscale-2402-comment-filter.md).

# MaxScale 24.02 Comment Filter

* [Comment Filter](#comment-filter)
  * [Overview](#overview)
  * [Filter Parameters](#filter-parameters)
    * [inject](#inject)
  * [Examples](#examples)
    * [Example 1 - Inject IP address of the connected client into statements](#example-1-inject-ip-address-of-the-connected-client-into-statements)

### Overview

With the *comment* filter it is possible to define comments that are\
injected before the actual statements. These comments appear as sql\
comments when they are received by the server.

```
[MyComment]
type=filter
module=comment
inject="Comment to be injected"

[MyService]
type=service
router=readwritesplit
servers=server1
user=myuser
password=mypasswd
filters=MyComment
```

### Filter Parameters

The Comment filter requires one mandatory parameter to be defined.

#### `inject`

* Type: string
* Mandatory: Yes
* Dynamic: Yes

A parameter that contains the comment injected before the statements.\
There is also defined variable $IP that can be used to comment the\
IP address of the client in the injected comment.\
Variables must be written in all caps.

### Examples

#### Example 1 - Inject IP address of the connected client into statements

as comment.

The following configuration adds the IP address of the client to the comment.

```
[IPComment]
type=filter
module=comment
inject="IP=$IP"

[MyService]
type=service
router=readwritesplit
servers=server1
user=myuser
password=mypasswd
filters=IPComment
```

In this example when MaxScale receives statement like:

```
SELECT user FROM people;
```

It would look like

```
/* IP=::ffff:127.0.0.1 */SELECT user FROM people;
```

when received by server.

<sub>*This page is licensed: CC BY-SA / Gnu FDL*</sub>

{% @marketo/form formId="4316" %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://mariadb.com/docs/maxscale/maxscale-archive/archive/mariadb-maxscale-24-02/maxscale-24-02filters/mariadb-maxscale-2402-maxscale-2402-comment-filter.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.