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

newrelic-lambda integrations update docs suggest --nr-account-id and --nr-api-key are optional, but they must be passed #266

Open
huonw opened this issue Mar 11, 2024 · 0 comments
Assignees
Labels
bug Something isn't working

Comments

@huonw
Copy link

huonw commented Mar 11, 2024

Description

The docs in the README for newrelic-lambda integrations update suggests that two arguments are optional: with the phrase "Only required if changing the account to which the logs are sent" and . They appear to be required in practice:

| `--nr-account-id` or `-a` | Yes | The [New Relic Account ID](https://docs.newrelic.com/docs/accounts/install-new-relic/account-setup/account-id) for the integration. Only required if changing the account to which the logs are sent. Can also use the `NEW_RELIC_ACCOUNT_ID` environment variable. |
| `--nr-api-key` or `-k` | Yes | Your [New Relic User API Key](https://docs.newrelic.com/docs/apis/get-started/intro-apis/types-new-relic-api-keys#user-api-key). Can also use the `NEW_RELIC_API_KEY` environment variable. Only required if changing the account to which the logs are sent. |

Steps to Reproduce

  1. Run newrelic-lambda integrations update without any args
  2. Run newrelic-lambda integrations update --nr-account-id 0

Expected Behaviour

One of:

  1. arguments are just documented as required
  2. the arguments are optional in practice
  3. more details on how to omit an arg, e.g. if there's some special way to indicate something doesn't change like --nr-account-id unchanged or something

Relevant Logs / Console output

  1. without any args: Error: Missing option '--nr-account-id' / '-a'.
  2. --nr-account-id 0 only: Error: Missing option '--nr-api-key' / '-k'.

Your Environment

macOS

# requirements.txt
newrelic-lambda-cli==0.9.0
boto3==1.34.59
botocore==1.34.59
jmespath==1.0.1
python-dateutil==2.9.0.post0
six==1.16.0
urllib3==2.0.7
s3transfer==0.10.0
click==8.1.7
colorama==0.4.6
emoji==2.10.1
gql==2.0.0
graphql-core==2.3.2
promise==2.3
Rx==1.6.3
requests==2.31.0
charset-normalizer==3.3.2
idna==3.6
certifi==2024.2.2
tabulate==0.9.0

Additional context

N/A

@huonw huonw added the bug Something isn't working label Mar 11, 2024
@chaudharysaket chaudharysaket self-assigned this Mar 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

2 participants