Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation: config for ingester/distributor memberlist is invalid #2754

Closed
zswanson opened this issue Oct 13, 2020 · 5 comments · Fixed by #3542
Closed

Documentation: config for ingester/distributor memberlist is invalid #2754

zswanson opened this issue Oct 13, 2020 · 5 comments · Fixed by #3542
Assignees

Comments

@zswanson
Copy link

Describe the bug
https://grafana.com/docs/loki/latest/configuration/#ingester_config
https://grafana.com/docs/loki/latest/configuration/#distributor_config

Current documentation for the ingester and distributor config describes the ring config as:

lifecycler:
  ring:
    kvstore:
      # Backend storage to use for the ring. Supported values are: consul, etcd,
      # inmemory, memberlist
      # CLI flag: -ring.store
      [store: <string> | default = "consul"]

      # The prefix for the keys in the store. Should end with a /.
      # CLI flag: -ring.prefix
      [prefix: <string> | default = "collectors/"]

      # The consul_config configures the consul client.
      # CLI flag: <no prefix>
      [consul: <consul_config>]

      # The etcd_config configures the etcd client.
      # CLI flag: <no prefix>
      [etcd: <etcd_config>]

      # Configuration for Gossip memberlist. Only applies if store is "memberlist"
      # CLI flag: <no prefix>
      [memberlist: <memberlist_config>]

The memberlist element in that heirarchy is incorrect, and will cause loki to err at startup with an invalid config. memberlist is actually a root level element and is defined once and then referenced with store: memberlist in the distributor and ingester configurations. While I have not tested it, I imagine the same holds true for consul and etcd configs.

Expected behavior
Documentation should be adjusted to add memberlist as a root element, and remove the definition from the distributor_config and ingester_config sections.

@stale
Copy link

stale bot commented Nov 13, 2020

This issue has been automatically marked as stale because it has not had any activity in the past 30 days. It will be closed in 7 days if no further activity occurs. Thank you for your contributions.

@stale stale bot added the stale A stale issue or PR that will automatically be closed. label Nov 13, 2020
@komapa
Copy link

komapa commented Nov 14, 2020

We had the same problem, the documentation is wrong and seems like it would be great to fix.

@stale stale bot removed the stale A stale issue or PR that will automatically be closed. label Nov 14, 2020
@james-callahan
Copy link
Contributor

I ran into this today.

I'm curious which components will have the memberlist port bound and should be listed in join_members. Currently I have:

memberlist:
    join_members:
      - distributor
      - ingester

However I have the suspicion that e.g. querier could be added to that list.

@lmickh
Copy link

lmickh commented Jan 7, 2021

The distributor, ingester, and querier should all have memberlist configs. Only the ingester will have tokens. The other two will use it to find the ingesters. You can look at the /ring path on the distributor api to see the tokens to verify the all of the ingesters are present.

@stale
Copy link

stale bot commented Feb 7, 2021

This issue has been automatically marked as stale because it has not had any activity in the past 30 days. It will be closed in 7 days if no further activity occurs. Thank you for your contributions.

@stale stale bot added the stale A stale issue or PR that will automatically be closed. label Feb 7, 2021
@stale stale bot removed the stale A stale issue or PR that will automatically be closed. label Mar 4, 2021
james-callahan added a commit to BitGo/kustomize-loki that referenced this issue Jun 23, 2021
james-callahan added a commit to BitGo/kustomize-loki that referenced this issue Jun 23, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

6 participants