Kong / Kong/developer.konghq.com

Incorrect description of `mem_cache_size`

Open Beginner friendly
#2,812 1 comment 0 reactions 0 assignees View on GitHub
bug-bash product:gateway user-reported
Dominant language
Ruby
Stars
28
Forks
121
Avg merge
1d 4h
Merged PRs (30d)
313

Description

The description of `mem_cache_size` is as follows:
https://developer.konghq.com/gateway/configuration/#mem-cache-size
> Size of each of the two shared memory caches for traditional mode database entities and runtime data, kong_core_cache and kong_cache.

However, there is no such thing as `kong_core_cache` in the source code.
The correct term is `kong.core_cache`.
https://github.com/search?q=repo%3AKong%2Fkong%20%22kong.core_cache%22&type=code

This is also documented in past release notes as follows:
https://github.com/Kong/kong/blob/master/CHANGELOG-OLD.md?plain=1#L2449
> The internal cache was split into two independent segments, `kong.core_cache` and `kong.cache`.

#### Conclusion:
Incorrect:
> Size of each of the two shared memory caches for traditional mode database entities and runtime data, `kong_core_cache` and `kong_cache`.

Correct (Revised description):
> Size of each of the two shared memory caches for traditional mode database entities and runtime data, `kong.core_cache` and `kong.cache`.

Contributor guide

No contributing guide indexed for this repository

Research direction

Open the configuration page linked in the issue and locate the `mem_cache_size` description. Compare it with the `CHANGELOG-OLD.md` entry cited, update the cache names to `kong.core_cache` and `kong.cache`, and verify the published description uses the revised wording.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Quiet
Clarity
Clearly specified
Newbie friendliness
76/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.