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

Consider adding more "secret" params to WF API #380

Open
philipmac opened this issue Nov 16, 2023 · 5 comments
Open

Consider adding more "secret" params to WF API #380

philipmac opened this issue Nov 16, 2023 · 5 comments

Comments

@philipmac
Copy link
Member

It may be useful to allow extra functionality / arguments / control to be injected into the WFs to help debugging, tune per run optimizations, etc.

For example:
log level: bool,
bioformats chunk size: int,
ng_shader_param_quantiles: [float, float]
rechunk_in_memory: bool

@blowekamp
Copy link
Collaborator

Note common logging systems use "[DEBUG|INFO|WARNING|ERROR]" for logging levels.

@annshress
Copy link
Collaborator

annshress commented Nov 16, 2023

Maybe, we can load them from .env file. Currently we have them already setup.

Passing these variables into functions during the testing phase to be able to test and tune parameters sounds good.

@philipmac
Copy link
Member Author

We could make current "secret" params clearer.

@philipmac
Copy link
Member Author

philipmac commented Dec 7, 2023

prefix any param that is not for public use is prefixed with x_

note - if the param is exposed at some later point, the x_ can be removed, the param can remain unchanged and now be "public"

@annshress
Copy link
Collaborator

annshress commented Dec 7, 2023

This is inspired by HTTP experimental or non-standard/custom headers.

In HTTP headers, the "X-" prefix is often used to denote non-standard or custom headers. Standard HTTP headers are defined by specifications like those outlined in the HTTP/1.1 RFCs (Request for Comments). However, developers and organizations may introduce custom headers for specific purposes.
The "X-" prefix indicates that a particular header is an extension or experimental header that is not part of the official HTTP specification. This naming convention helps prevent clashes with future standard headers that might be introduced in subsequent HTTP versions.

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

No branches or pull requests

3 participants