search

mozilla-services / heka

DEPRECATED: Data collection and processing made easy.
http://hekad.readthedocs.org/
Other
3.39k stars 529 forks source link

Improve documentation of `output_limit` and friends #1763

Open zstyblik opened 9 years ago

zstyblik commented 9 years ago

Hello,

please, please improve documentation for output_limit, memory_limit and alike.

Quote from documentation:

output_limit (uint):

The number of bytes managed sandbox output buffers can hold before being terminated (default 63KiB). Warning: messages exceeding 64KiB will generate an error and be discarded by the standard output plugins (File, TCP, UDP) since they exceed the maximum message size.

uint is expected, got it. So 100KiB won't fly. Now, is 1 equal to 1KiB or 1B? Is there some internal logic that does that?

memory_limit (uint):

The number of bytes managed sandboxes are allowed to consume before being terminated (default 8MiB).

Does memory_limit = 8 set memory_limit to 8MiB or 8B or 8 of what actually? I mean, it just isn't clear to me and even examples, eg. ``memory_limit = 8 sets memory limit to 8MiB'' would really help.

Thank you, Z.

trink commented 9 years ago

As the docs state it is the number of bytes so if you want 100KiB the setting should be output_limit = 102400

zstyblik commented 9 years ago

facepalm I see. It still might be worth to add something for clarity ... for people like me. However, if you think it's not necessary, I agree with this issue being closed. Obviously, error was on my end.

Thank you.

Z.