feat(pdk) add kong.node module with '.get_id()' util #3826
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This new module provides node-level utilities, such as `kong.node.get_id()`, which is a replacement to the old `kong.tools.public` module's `get_node_id()` utility. Reminder: the `kong.tools.public` module is to be stripped away for the 1.0 stable release. This new implementation **throws** errors instead of returning them, for two reasons: 1. Simplicity of usage: now that this function is exposed for public consumption (and already used by plugins such as Zipkin), avoiding for the need to check for errors simplifies its usage. 2. If such an error occurs, it will be during the initialization of the master process, and will then properly prevent Kong from starting. At runtime, no such error should occur since the id is cached, but if they do, they should be very obvious and provide their stacktraces. The `kong.node` module could also contain the following utilities in the future: * get_hostname() * get_system_infos() * ...
hishamhm
reviewed
Oct 4, 2018
| -- @function kong.node.get_id | ||
| -- @treturn string The v4 UUID used by this node as its id | ||
| -- @usage | ||
| -- local id, err = kong.node.get_id() |
There was a problem hiding this comment.
The example says get_id may return a second err argument, but that's not the case. I suggest changing to local node_id = assert(kong.node.get_id()) (no hard feelings either way about the assert, just an idea to convey "should always work")
There was a problem hiding this comment.
Ugh, a leftover from prior to this change! Thanks!
Oops, my bad! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This new module provides node-level utilities, such as
kong.node.get_id(), which is a replacement to the oldkong.tools.publicmodule'sget_node_id()utility.Reminder: the
kong.tools.publicmodule is to be stripped away for the1.0 stable release.
This new implementation throws errors instead of returning them, for
two reasons:
consumption (and already used by plugins such as Zipkin), avoiding for
the need to check for errors simplifies its usage.
master process, and will then properly prevent Kong from starting. At
runtime, no such error should occur since the id is cached, but if they
do, they should be very obvious and provide their stacktraces.
The
kong.nodemodule could also contain the following utilities in thefuture: