doc: timeout must be greater than 1000

prometheus-community / ipmi_exporter

Remote IPMI exporter for Prometheus

MIT License

471 stars 133 forks source link

doc: timeout must be greater than 1000 #78

Closed oliverpool closed 2 years ago

oliverpool commented 3 years ago

I just had an issue, where the dcmi collector returned:

ipmi_ctx_open_outofband_2_0: invalid parameters

It was because I set the timeout to 1000, but this was too low since it has to be greater than retransmission-timeout which defaults to 1000: https://www.gnu.org/software/freeipmi/manpages/man8/ipmi-dcmi.8.html

This PR documents this configuration subtlety

bitfehler commented 2 years ago

Thanks a lot (and sorry for the delay). I am not entirely sure that this will not actually cause more confusion by giving folks the impression that they could configure the retransmission timeout in the exporter YAML, but let's see. I will merge this for now, especially since your report made me realize that this little tidbid is not mentioned in man 5 freeipmi.conf :disappointed: (which is already mentioned in the sample config).