Anonymitaet commented on PR #17099:
URL: https://github.com/apache/pulsar/pull/17099#issuecomment-1217696364
@RobertIndie @BewareMyPower thanks for your suggestions!
I've updated this PR based on your comments. The changes are summarized
below, PTAL.
1. Keep the following content for 2.8.x and 2.9.x.
```
## Broker entry metadata
Broker entry metadata is stored alongside the message metadata as a
serialized protobuf message.
It is created by the broker when the message arrived at the broker and
passed without changes to the consumer if configured.
| Field | Required or optional | Description
|
|:-------------------|:----------------|:------------------------------------------------------------------------------------------------------------------------------|
| `broker_timestamp` | Optional | The timestamp when a message
arrived at the broker (`id est` as the number of milliseconds since January
1st, 1970 in UTC) |
| `index` | Optional | The index of the message. It is
assigned by the broker.
If you want to use broker entry metadata for **brokers**, configure the
[`brokerEntryMetadataInterceptors`](reference-configuration.md#broker)
parameter in the `broker.conf` file.
```
2. Keep the following content for 2.10.x.
```
## Broker entry metadata
Broker entry metadata is stored alongside the message metadata as a
serialized protobuf message.
It is created by the broker when the message arrived at the broker and
passed without changes to the consumer if configured.
| Field | Required or optional | Description
|
|:-------------------|:----------------|:------------------------------------------------------------------------------------------------------------------------------|
| `broker_timestamp` | Optional | The timestamp when a message
arrived at the broker (`id est` as the number of milliseconds since January
1st, 1970 in UTC) |
| `index` | Optional | The index of the message. It is
assigned by the broker.
If you want to use broker entry metadata for **brokers**, configure the
[`brokerEntryMetadataInterceptors`](reference-configuration.md#broker)
parameter in the `broker.conf` file.
If you want to use broker entry metadata for **consumers**:
1. Use the client protocol version [18 or
later](https://github.com/apache/pulsar/blob/ca37e67211feda4f7e0984e6414e707f1c1dfd07/pulsar-common/src/main/proto/PulsarApi.proto#L259).
2. Configure the
[`brokerEntryMetadataInterceptors`](reference-configuration.md#broker)
parameter and set the
[`exposingBrokerEntryMetadataToClientEnabled`](reference-configuration-broker.md#exposingbrokerentrymetadatatoclientenabled)
parameter to `true` in the `broker.conf` file.
```
3. Remove the following content for versions prior to 2.8.0.
```
## Broker entry metadata
Broker entry metadata is stored alongside the message metadata as a
serialized protobuf message.
It is created by the broker when the message arrived at the broker and
passed without changes to the consumer if configured.
| Field | Required or optional | Description
|
|:-------------------|:----------------|:------------------------------------------------------------------------------------------------------------------------------|
| `broker_timestamp` | Optional | The timestamp when a message
arrived at the broker (`id est` as the number of milliseconds since January
1st, 1970 in UTC) |
| `index` | Optional | The index of the message. It is
assigned by the broker.
If you want to use broker entry metadata for **brokers**, configure the
[`brokerEntryMetadataInterceptors`](reference-configuration.md#broker)
parameter in the `broker.conf` file.
If you want to use broker entry metadata for **consumers**:
1. Use the client protocol version [18 or
later](https://github.com/apache/pulsar/blob/ca37e67211feda4f7e0984e6414e707f1c1dfd07/pulsar-common/src/main/proto/PulsarApi.proto#L259).
2. Configure the
[`brokerEntryMetadataInterceptors`](reference-configuration.md#broker)
parameter and set the
[`exposingBrokerEntryMetadataToClientEnabled`](reference-configuration-broker.md#exposingbrokerentrymetadatatoclientenabled)
parameter to `true` in the `broker.conf` file.
```
4. Ignore updating the versions in red and only updating versions in green
since red are deprecated. Details see [Update versioned
docs](https://docs.google.com/document/d/1-1uJyd1k9_h56xiiVRVOnrLcCnTmg9n7SrHhNVNEEi4/edit#bookmark=id.q5m2r5pimdi6).
<img width="235" alt="image"
src="https://user-images.githubusercontent.com/50226895/185074601-218a45f3-e74d-44e0-8fd4-e4104dd4bff8.png";>
cc @momo-jun
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
![https://user-images.githubusercontent.com/50226895/185074601-218a45f3-e74d-44e0-8fd4-e4104dd4bff8.png"](https://user-images.githubusercontent.com/50226895/185074601-218a45f3-e74d-44e0-8fd4-e4104dd4bff8.png"){kind=link}