Merge pull request #6 from framer/chore/merge-upstream

Merge changes from upstream

.github/workflows/pr.yaml

@@ -0,0 +1,45 @@
+name: New Relic - AWS Logs Ingestion - Pull Request
+
+on: [pull_request]
+
+jobs:
+  lint:
+    strategy:
+      matrix:
+        python-version: ["3.11"]
+        poetry-version: ["1.4"]
+        os: [ubuntu-20.04]
+    runs-on: ${{ matrix.os }}
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install Poetry
+        uses: snok/install-poetry@v1
+        with:
+          poetry-version: ${{ matrix.poetry-version }}
+      - name: Install Project
+        run: poetry install --no-interaction
+      - name: Lint
+        run: |
+          poetry run flake8 src test
+          poetry run black --check src test
+  test:
+    strategy:
+      matrix:
+        python-version: ["3.11"]
+        poetry-version: ["1.4"]
+        os: [ubuntu-20.04, ubuntu-22.04]
+    runs-on: ${{ matrix.os }}
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install Poetry
+        uses: snok/install-poetry@v1
+      - name: Install Project
+        run: poetry install --no-interaction
+      - name: Test
+        run: poetry run pytest

.gitignore

@@ -14,6 +14,7 @@ __pycache__/
 
 packaged.yaml
 .aws-sam/
+samconfig.toml
 /src/requirements.txt
 
 .serverless

.pre-commit-config.yaml

@@ -1,5 +1,6 @@
+repos:
 -   repo: https://github.com/psf/black
-    rev: stable
+    rev: 22.3.0
     hooks:
     - id: black
-      language_version: python3.7
+      language_version: python3.11

Developer.md

@@ -10,8 +10,11 @@
 
 # Publishing a new version
 
-To publish a new version [create a release](https://github.com/newrelic/aws-log-ingestion/releases/new)
-and specify a tag that matches the `SemanticVersion` that appears in the `template.yml`
+The version number needs to be bumped in `pyproject.toml` and `template.yaml` (in `Metadata.SemanticVersion`).
+Note that both should match.
+
+Then, to publish a new version, [create a release](https://github.com/newrelic/aws-log-ingestion/releases/new)
+and specify a tag that matches the `SemanticVersion` that appears in `template.yml` (and `pyproject.toml`)
 but prefixed with a `v`. For example, if the `SemanticVersion` is `1.2.3` then your
 release tag should be `v1.2.3`.
 

Dockerfile

@@ -1,4 +1,4 @@
-FROM python:3.7
+FROM python:3.11
 RUN apt-get update
 RUN apt-get install -y zip
 

README.md

@@ -13,7 +13,8 @@ To forward data to New Relic you need a [New Relic License Key](https://docs.new
 To install and configure the New Relic Cloudwatch Logs Lambda, [see our documentation](https://docs.newrelic.com/docs/logs/enable-logs/enable-logs/aws-cloudwatch-plugin-logs).
 
 Additional notes:
-* Some users in UTF-8 environments have reported difficulty with defining strings of `NR_TAGS` delimited by the semicolon `;` character. If this applies to you, you can set an alternative delimiter character as the value of `NR_ENV_DELIMITER`, and separate your `NR_TAGS` with that. 
+
+* Some users in UTF-8 environments have reported difficulty with defining strings of `NR_TAGS` delimited by the semicolon `;` character. If this applies to you, you can set an alternative delimiter character as the value of `NR_ENV_DELIMITER`, and separate your `NR_TAGS` with that.
 * Custom Lambda and VPC log groups can be set using the `NR_LAMBDA_LOG_GROUP_PREFIX` and `NR_VPC_LOG_GROUP_PREFIX` environment variables.
 
 ## Manual Deployment
@@ -24,7 +25,7 @@ to deploy the log ingestion function manually.
 ### SAM
 
 1. Clone this repository: `git clone https://github.com/newrelic/aws-log-ingestion.git`
-2. [Install the SAM CLI](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/serverless-sam-cli-install.html) Make sure you have >=0.33.0 installed, you can check with `sam --version`.
+2. [Install the SAM CLI](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/serverless-sam-cli-install.html) Make sure you have >=1.105.0 installed, you can check with `sam --version`.
 3. [Retrieve your New Relic License Key](https://docs.newrelic.com/docs/accounts/install-new-relic/account-setup/license-key)
 4. Build the SAM application (if on Linux `-u` can be omitted): `sam build -u --parameter-overrides 'ParameterKey=NRLicenseKey,ParameterValue=your-license-key-here'`
 5. Deploy the SAM application: `sam deploy --guided`
@@ -59,3 +60,46 @@ module "newrelic_log_ingestion" {
 ```
 
 By default, this will build and pack the lambda zip inside of the Terraform Module. You can supply your own by switching `build_lambda = false`, and specify the path to your lambda, using `lambda_archive = "{{LAMBDA_PATH}}"`, replacing `{{LAMBDA_PATH}}` with the path to your lambda.
+
+## Infra Payload Format
+
+The maximum payload size in bytes is:
+
+<https://github.com/newrelic/aws-log-ingestion/blob/1430a247f1fb5feb844f0707838a6ef48d21fc41/src/function.py#L76>
+
+If your payload exceeds this size, you will need to split it into pieces:
+
+<https://github.com/newrelic/aws-log-ingestion/blob/1430a247f1fb5feb844f0707838a6ef48d21fc41/src/function.py#L292-L306>
+
+The payload should be utf-8 encoded and then gzipped before sending:
+
+<https://github.com/newrelic/aws-log-ingestion/blob/1430a247f1fb5feb844f0707838a6ef48d21fc41/src/function.py#L298>
+
+The following GNU coreutils Bash command will reproduce the desired payload encoding and compression:
+
+```sh
+xclip -sel clip -o | iconv -cf utf-8 | gzip > payload.gz
+```
+
+Required headers include:
+
+* <https://github.com/newrelic/aws-log-ingestion/blob/1430a247f1fb5feb844f0707838a6ef48d21fc41/src/function.py#L360-L361>
+* `Accept-Encoding: gzip`
+* `Content-Length: <calculated when request is sent>`
+* `Host: <calculated when request is sent>`
+
+The payload should include the following (properly escaped) elements[^1]:
+
+```json
+{
+  "context": {
+    "function_name": "newrelic-log-ingestion",
+    "invoked_function_arn": "arn:aws:lambda:<your_aws_region>:<your_aws_account>:function:newrelic-log-ingestion",
+    "log_group_name": "/aws/lambda/newrelic-log-ingestion",
+    "log_stream_name": "<your_nli_log_stream_name>"
+  },
+  "entry": "{\"messageType\": \"DATA_MESSAGE\", \"owner\": \"<your_aws_account>\", \"logGroup\": \"/aws/lambda/<your_function_name>\", \"logStream\": \"<your_function_log_stream_name>\", \"subscriptionFilters\": [\"<your_function_name>\"], \"logEvents\": [{\"id\": \"36858672311120633630098786383886689203484013407063113737\", \"timestamp\": 1652800029012, \"message\": \"[1,\\\"NR_LAMBDA_MONITORING\\\",\\\"H4sIAAAAAAAAA+1Y3W/bNhB/919hCHu0JUrUF40hQLZ2WIBiLWBveygKgZZOHjea0kjJiRvkfx8lS66s2Elqx0XXVC/U3ZG8u98djx+3g+HQWEJBE1pQYzK81bTmUCk0UTUTeq0mnC7nCZ38uM5KGWlGJGHBMnHR4dA4zkpRXEzSUsSFFjaylowEXcKFMdrMv+WuQCrdVsp+eHM5ez2dtV3gBuKy7gNixWQmliCKqt/ln9PoTW1QJLIE/la2a960o3KZFVmc8c7Ett/I6ELP0NUYmjYykaGld1UXYxcDjYpkcdQw39fM4VCUnI+af9v3nBAh5IQmsYN7XGIiRFpuO777N2xUtZ9RYVQZNi3zPJMFnTPOirX1W+2m9cfGcst2jc6wu1GHeL8znz3aIdEpZIf6sP3/MDrdq8s85yymVaSttzkIJhbWq1LWjCP9NO3AsZ0wQP4ZBTq+vhM6xHYd4mDXxe4XgehKsIJRzj5uyFORcoLw2VgoCJzQRdvPeX5ALt9dWQqKzfL/lYqEg/yWFsNMUqFoXRqVNYVFVfPUcQ46J5BnSOVpTsXrlXbHmmUF5fWvmgIcm7lfV/gOeKc3rP+ld2+Lv0B2ctH6pdmvrb2b+pG1R5cIm/iYnIePzdDzCcKO3ZQjD8YoPAM4dcRnbAnfUXoohSjnLxyCbaK8MBzaM8pP6591EoC0fhf/iOxaHGxfXqocA1GdXi8Mp/5xUFC+LlisNhvuN3m0eNDHr+iAMei2jceG0ueiCCpjH7pHfwLCkKBArjImI8U+VnA4Ons+6TfquVSkqujqq/2g5/iTbtnFOt8ArY0zRj2ZpDFcJZV47oQkTfHcRT4loRejuWN7BOyYkCTAHukPXZSsHodTm+A0BcCYpj5O9qhod4SNogAF1PPjIIXEoQH2+wMUXeYcqq6FLKEnzCXLpM6TCg3TdwPkeqP9efWZh7reLPr6CYtMVnqMBQiQLL7nmN7aVKGNrR9d2kcQvfh7/ZL2zjo5WEAMIU0daLl+l7H61WeP5x0czWc+uN7uUrt66bUyNw9i5pmfyXZUSvi31PBuUsZHCaE+xeMU2zB2Mfhj4tJgHLqhB8hPQ0rvpVHH7jjjybSg8gCyQkZwE/NSsRVEbbSiJeOcqTpodcS64D1SBmhTw04rBfVm8sy14Brmr3bTEbseCdzgibmNz7LYkieZtD1OPrCO2lrXMaWvDKTMpO6TUq72rLFTy+Fj1e3xArZb/76v2fs4HFp+g0p2N/gPfrgCl+UXAAA=\\\"]\\n\"}, {\"id\": \"36858672311232137356091439499594367794847255214593015820\", \"timestamp\": 1652800029017, \"message\": \"REPORT RequestId: 60d9a6a3-f31e-43e6-94a7-8485e06f8aa6\\tDuration: 13.98 ms\\tBilled Duration: 14 ms\\tMemory Size: 1024 MB\\tMax Memory Used: 87 MB\\tInit Duration: 584.39 ms\\t\\n\"}]}"
+}
+```
+
+[^1]: Replace <your_xyz> elements with your content, for example: `"log_stream_name": "2022/05/17/[$LATEST]30dce751bc1a4e7497eb644171d70153"`.