[ 
https://issues.apache.org/jira/browse/KAFKA-14459?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
 ]

A. Sophie Blee-Goldman updated KAFKA-14459:
-------------------------------------------
    Labels: docs newbie  (was: )

> Document how to use and close a 'Statistics' in the example 
> RocksDBConfigSetter
> -------------------------------------------------------------------------------
>
>                 Key: KAFKA-14459
>                 URL: https://issues.apache.org/jira/browse/KAFKA-14459
>             Project: Kafka
>          Issue Type: Improvement
>          Components: docs, streams
>            Reporter: A. Sophie Blee-Goldman
>            Priority: Major
>              Labels: docs, newbie
>
> We fixed a memory leak in KAFKA-14432 where we were sometimes failing to 
> close the `Statistics` object used for rocksdb metrics. Since users can 
> define their own Statistics as well, we should make sure they know that this 
> has to be closed like we do for other `RocksDBObject` classes like the Cache. 
> It might also be useful to provide an example of how to use Statistics and 
> what can be done with it.
>  
> We currently have two sample RocksDBConfigSetter implementations in the docs, 
> both of which could be updated here:
>  # [rocksdb memory management 
> docs](https://kafka.apache.org/documentation/streams/developer-guide/memory-mgmt.html#rocksdb)
>  -- consider including a Statistics in this example to highlight that it 
> needs to be closed? This one could arguably be skipped, although the 
> formatting of this sample config setter seems to be messed up so this might 
> be a good opportunity to fix that on the side
>  # [rocksdb.config.setter config 
> docs](https://kafka.apache.org/documentation/streams/developer-guide/config-streams.html#id20):
>  this would be a good place to include an example that actually uses the 
> Statistics for something (assuming there's some reason for users to define 
> their own Statistics in the first place, which I personally do not know). We 
> can potentially link to this example from the metrics docs



--
This message was sent by Atlassian Jira
(v8.20.10#820010)

Reply via email to