Metadata-Version: 2.1
Name: newrelic-lambda-cli
Version: 0.1.0
Summary: A CLI to install the New Relic AWS Lambda integration and layers.
Home-page: https://github.com/newrelic/newrelic-lambda-cli
Author: New Relic
Author-email: serverless-dev@newrelic.com
License: UNKNOWN
Description: newrelic-lambda-cli
        ===================
        
        A CLI to install the New Relic AWS Lambda integration and layers.
        
        Features
        --------
        
        -  Installs the New Relic AWS Lambda integration onto your AWS account
        -  Installs and configures a New Relic AWS Lambda layer onto your AWS
           Lambda functions
        -  Automatically selects the correct New Relic layer for your function’s
           runtime and region
        -  Wraps your AWS Lambda functions without requiring a code change
        -  Supports Node.js and Python AWS LAmbda runtimes
        -  Easily uninstall the AWS Lambda layer with a single command
        
        Runtimes Supported
        ------------------
        
        -  nodejs10.x
        -  nodejs12.x
        -  python2.7
        -  python3.6
        -  python3.7
        
        Requirements
        ------------
        
        -  Retrieve your `New relic Account
           ID <https://docs.newrelic.com/docs/accounts/install-new-relic/account-setup/account-id>`__
           and `User API
           Key <https://docs.newrelic.com/docs/apis/get-started/intro-apis/types-new-relic-api-keys#user-api-key>`__
        
        Recommendations
        ---------------
        
        -  Install the `AWS CLI <https://github.com/aws/aws-cli>`__ and
           configure your environment with ``aws configure``
        
        Installation
        ------------
        
        .. code:: bash
        
           pip install newrelic-lambda-cli
        
        Or clone this repo and run:
        
        .. code:: bash
        
           python setup.py install
        
        Usage
        -----
        
        AWS Lambda Integration
        ~~~~~~~~~~~~~~~~~~~~~~
        
        Install Integration
        ^^^^^^^^^^^^^^^^^^^
        
        In order to instrument your AWS Lambda functions using New Relic you
        must first install the New Relic AWS Lambda integration and the log
        ingestion function in the AWS region in which your Lambda functions are
        located. If you have Lambda functions located in multiple regions you
        can run the command multiple times specifying the AWS regions with
        ``--aws-region <your aws region here>``. This command only needs to be
        run once per AWS region. By default this command will look for a default
        AWS profile configured via the AWS CLI.
        
        .. code:: bash
        
           newrelic-lambda integrations install \
               --nr-account-id <account id> \
               --nr-api-key <api key> \
               --linked-account-name <linked account name>
        
        +-----------------+-----------------------+----------------------------+
        | Option          | Required?             | Description                |
        +=================+=======================+============================+
        | ``--nr-account- | Yes                   | The `New Relic Account     |
        | id``            |                       | ID <https://docs.newrelic. |
        | or ``-a``       |                       | com/docs/accounts/install- |
        |                 |                       | new-relic/account-setup/ac |
        |                 |                       | count-id>`__               |
        |                 |                       | for this integration. Can  |
        |                 |                       | also use the               |
        |                 |                       | ``NEW_RELIC_ACCOUNT_ID``   |
        |                 |                       | environment variable.      |
        +-----------------+-----------------------+----------------------------+
        | ``--nr-api-key` | Yes                   | Your `New Relic User API   |
        | `               |                       | Key <https://docs.newrelic |
        | or ``-k``       |                       | .com/docs/apis/get-started |
        |                 |                       | /intro-apis/types-new-reli |
        |                 |                       | c-api-keys#user-api-key>`_ |
        |                 |                       | _.                         |
        |                 |                       | Can also use the           |
        |                 |                       | ``NEW_RELIC_API_KEY``      |
        |                 |                       | environment variable.      |
        +-----------------+-----------------------+----------------------------+
        | ``--linked-acco | Yes                   | A label for the New Relic  |
        | unt-key``       |                       | Linked ACcount. This is    |
        | or ``-l``       |                       | how this integration will  |
        |                 |                       | appear in New Relic.       |
        +-----------------+-----------------------+----------------------------+
        | ``--nr-region`` | No                    | The New Relic region to    |
        |                 |                       | use for the integration.   |
        |                 |                       | Can use the                |
        |                 |                       | ``NEW_RELIC_REGION``       |
        |                 |                       | environment variable.      |
        |                 |                       | Defaults to ``us``.        |
        +-----------------+-----------------------+----------------------------+
        | ``--aws-profile | No                    | The AWS profile to use for |
        | ``              |                       | this command. Can also use |
        | or ``-p``       |                       | ``AWS_PROFILE``. Defaults  |
        |                 |                       | to ``default``. Will also  |
        |                 |                       | check                      |
        |                 |                       | ``AWS_ACCESS_KEY_ID`` and  |
        |                 |                       | ``AWS_SECRET_ACCESS_KEY``  |
        |                 |                       | environment variables if   |
        |                 |                       | not using AWS CLI.         |
        +-----------------+-----------------------+----------------------------+
        | ``--aws-region` | No                    | The AWS region for the     |
        | `               |                       | integration. Can use       |
        | or ``-r``       |                       | ``AWS_DEFAULT_REGION``     |
        |                 |                       | environment variable.      |
        |                 |                       | Defaults to AWS profile    |
        |                 |                       | default.                   |
        +-----------------+-----------------------+----------------------------+
        | ``--aws-role-po | No                    | Specify an alternative IAM |
        | licy``          |                       | role policy ARN for this   |
        |                 |                       | integration.               |
        +-----------------+-----------------------+----------------------------+
        
        Uninstall Integration
        ^^^^^^^^^^^^^^^^^^^^^
        
        .. code:: bash
        
           newrelic-lambda integrations uninstall
        
        +-----------------+-----------------------+----------------------------+
        | Option          | Required?             | Description                |
        +=================+=======================+============================+
        | ``--aws-profile | No                    | The AWS profile to use for |
        | ``              |                       | this command. Can also use |
        | or ``-p``       |                       | ``AWS_PROFILE``. Defaults  |
        |                 |                       | to ``default``. Will also  |
        |                 |                       | check                      |
        |                 |                       | ``AWS_ACCESS_KEY_ID`` and  |
        |                 |                       | ``AWS_SECRET_ACCESS_KEY``  |
        |                 |                       | environment variables if   |
        |                 |                       | not using AWS CLI.         |
        +-----------------+-----------------------+----------------------------+
        | ``--aws-region` | No                    | The AWS region for the     |
        | `               |                       | integration. Can use       |
        | or ``-r``       |                       | ``AWS_DEFAULT_REGION``     |
        |                 |                       | environment variable.      |
        |                 |                       | Defaults to AWS profile    |
        |                 |                       | default.                   |
        +-----------------+-----------------------+----------------------------+
        
        AWS Lambda Layers
        ~~~~~~~~~~~~~~~~~
        
        Install Layer
        ^^^^^^^^^^^^^
        
        .. code:: bash
        
           newrelic-lambda layers install \
               --function <name or arn> \
               --nr-account-id <new relic account id>
        
        +-----------------+-----------------------+----------------------------+
        | Option          | Required?             | Description                |
        +=================+=======================+============================+
        | ``--function``  | Yes                   | The AWS Lambda function    |
        | or ``-f``       |                       | name or ARN in which to    |
        |                 |                       | add a layer.               |
        +-----------------+-----------------------+----------------------------+
        | ``--nr-account- | Yes                   | The `New Relic Account     |
        | id``            |                       | ID <https://docs.newrelic. |
        | or ``-a``       |                       | com/docs/accounts/install- |
        |                 |                       | new-relic/account-setup/ac |
        |                 |                       | count-id>`__               |
        |                 |                       | this function should use.  |
        |                 |                       | Can also use the           |
        |                 |                       | ``NEW_RELIC_ACCOUNT_ID``   |
        |                 |                       | environment variable.      |
        +-----------------+-----------------------+----------------------------+
        | ``--layer-arn`` | No                    | Specify a specific layer   |
        | or ``-l``       |                       | version ARN to use. This   |
        |                 |                       | is auto detected by        |
        |                 |                       | default.                   |
        +-----------------+-----------------------+----------------------------+
        | ``--upgrade``   | No                    | Permit upgrade to the      |
        | or ``-u``       |                       | latest layer version for   |
        |                 |                       | this region and runtime.   |
        +-----------------+-----------------------+----------------------------+
        | ``--aws-profile | No                    | The AWS profile to use for |
        | ``              |                       | this command. Can also use |
        | or ``-p``       |                       | ``AWS_PROFILE``. Defaults  |
        |                 |                       | to ``default``. Will also  |
        |                 |                       | check                      |
        |                 |                       | ``AWS_ACCESS_KEY_ID`` and  |
        |                 |                       | ``AWS_SECRET_ACCESS_KEY``  |
        |                 |                       | environment variables if   |
        |                 |                       | not using AWS CLI.         |
        +-----------------+-----------------------+----------------------------+
        | ``--aws-region` | No                    | The AWS region this        |
        | `               |                       | function is located. Can   |
        | or ``-r``       |                       | use ``AWS_DEFAULT_REGION`` |
        |                 |                       | environment variable.      |
        |                 |                       | Defaults to AWS profile    |
        |                 |                       | default.                   |
        +-----------------+-----------------------+----------------------------+
        
        Uninstall Layer
        ^^^^^^^^^^^^^^^
        
        .. code:: bash
        
           newrelic-lambda layers uninstall --function <name or arn>
        
        +-----------------+-----------------------+----------------------------+
        | Option          | Required?             | Description                |
        +=================+=======================+============================+
        | ``--function``  | Yes                   | The AWS Lambda function    |
        | or ``-f``       |                       | name or ARN in which to    |
        |                 |                       | remove a layer.            |
        +-----------------+-----------------------+----------------------------+
        | ``--layer-arn`` | No                    | Specify a specific layer   |
        | or ``-l``       |                       | version ARN to remove.     |
        |                 |                       | This is auto detected by   |
        |                 |                       | default.                   |
        +-----------------+-----------------------+----------------------------+
        | ``--aws-profile | No                    | The AWS profile to use for |
        | ``              |                       | this command. Can also use |
        | or ``-p``       |                       | ``AWS_PROFILE``. Defaults  |
        |                 |                       | to ``default``. Will also  |
        |                 |                       | check                      |
        |                 |                       | ``AWS_ACCESS_KEY_ID`` and  |
        |                 |                       | ``AWS_SECRET_ACCESS_KEY``  |
        |                 |                       | environment variables if   |
        |                 |                       | not using AWS CLI.         |
        +-----------------+-----------------------+----------------------------+
        | ``--aws-region` | No                    | The AWS region this        |
        | `               |                       | function is located. Can   |
        | or ``-r``       |                       | use ``AWS_DEFAULT_REGION`` |
        |                 |                       | environment variable.      |
        |                 |                       | Defaults to AWS profile    |
        |                 |                       | default.                   |
        +-----------------+-----------------------+----------------------------+
        
        AWS Lambda Functions
        ~~~~~~~~~~~~~~~~~~~~
        
        List Functions
        ^^^^^^^^^^^^^^
        
        .. code:: bash
        
           newrelic-lambda functions list
        
        List functions with layer installed:
        
        .. code:: bash
        
           newrelic-lambda functions list --filter installed
        
        +-----------------+-----------------------+----------------------------+
        | Option          | Required?             | Description                |
        +=================+=======================+============================+
        | ``--filter`` or | No                    | Filter to be applied to    |
        | ``-f``          |                       | list of functions. Options |
        |                 |                       | are ``all``, ``installed`` |
        |                 |                       | and ``not-installed``.     |
        |                 |                       | Defaults to ``all``.       |
        +-----------------+-----------------------+----------------------------+
        | ``--aws-profile | No                    | The AWS profile to use for |
        | ``              |                       | this command. Can also use |
        | or ``-p``       |                       | ``AWS_PROFILE``. Defaults  |
        |                 |                       | to ``default``. Will also  |
        |                 |                       | check                      |
        |                 |                       | ``AWS_ACCESS_KEY_ID`` and  |
        |                 |                       | ``AWS_SECRET_ACCESS_KEY``  |
        |                 |                       | environment variables if   |
        |                 |                       | not using AWS CLI.         |
        +-----------------+-----------------------+----------------------------+
        | ``--aws-region` | No                    | The AWS region to use for  |
        | `               |                       | htis command. Can use      |
        | or ``-r``       |                       | ``AWS_DEFAULT_REGION``     |
        |                 |                       | environment variable.      |
        |                 |                       | Defaults to AWS profile    |
        |                 |                       | default.                   |
        +-----------------+-----------------------+----------------------------+
        
        Contributing
        ------------
        
        We welcome code contributions (in the form of pull requests) from our
        user community. Before submitting a pull request please review `these
        guidelines <CONTRIBUTING.md>`__.
        
        Following these helps us efficiently review and incorporate your
        contribution and avoid breaking your code with future changes to the
        agent.
        
        Code style
        ----------
        
        We use the `black <https://github.com/ambv/black>`__ code formatter.
        
        .. code:: bash
        
           pip install black
        
        We recommend using it with
        `pre-commit <https://pre-commit.com/#install>`__:
        
        .. code:: bash
        
           pip install pre-commit
           pre-commit install
        
        Using these together will auto format your git commits.
        
        Running Tests
        -------------
        
        .. code:: bash
        
           python setup.py test
        
Platform: UNKNOWN
Requires-Python: >=3.3
Description-Content-Type: text/x-rst
