Merge branch 'master' into DOC-870

logzio · Dec 3, 2024 · a68fac5 · a68fac5
2 parents a73ab9b + 414cc6c
commit a68fac5
Show file tree

Hide file tree

Showing 401 changed files with 8,146 additions and 5,755 deletions.
diff --git a/.github/workflows/pr_validate.yaml b/.github/workflows/pr_validate.yaml
@@ -11,13 +11,18 @@ jobs:
     runs-on: ubuntu-latest
     env:
       MANIFEST_PATH: '_manifest/validation_manifest.json'
+    permissions:
+      contents: 'write'
+      packages: 'read'
+      actions: 'write'
+      statuses: 'write'
     steps:
       - name: Checkout PR
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           ref: ${{ github.head_ref }}
           fetch-depth: 0
-      - uses: actions/setup-python@v4
+      - uses: actions/setup-python@v5
         with:
           python-version: '3.10'
       - name: install dependencies
@@ -96,14 +101,14 @@ jobs:
           python _manifest/manifest_generator.py
           echo "Copying file into manifest path"
           cp ${{env.MANIFEST_PATH}} static/manifest.json
-      - uses: stefanzweifel/git-auto-commit-action@v4
+      - uses: stefanzweifel/git-auto-commit-action@v5
         id: auto_commit_manifest
         if: steps.create_manifest.outputs.skip_next_step != 'true' && steps.create_manifest.outcome == 'success'
         with:
           file_pattern: './static/manifest.json'
           commit_message: 'auto generated manifest'
           commit_options: "--no-gpg-sign"
-          push_options: '--force'
+          push_options: '--force'      
       - name: Manifest update success
         if: steps.create_manifest.outputs.skip_next_step != 'true' && steps.run_validation.outputs.skip_next_step != 'true'
         run: |

diff --git a/docs/_include/account-info/distributed-tracing.md b/docs/_include/account-info/distributed-tracing.md
@@ -6,7 +6,6 @@ You can view your Distributed Tracing account plan and the specific details and
 
 :::note
 If you don't have a Distributed Tracing account yet, start a trial in the Distributed Tracing tab.
-<!-- reach out to your account manager or email [the Sales team](mailto:[email protected]).-->
 :::
 
 

diff --git a/docs/_include/general-shipping/gcp-logs.md b/docs/_include/general-shipping/gcp-logs.md
@@ -9,13 +9,12 @@ This integration is based on [`logzio-google-pubsub`](https://github.com/logzio/
 
 ### Run Google Cloud Shell configuration
 
-Use the following link, to clone the solution's repo and use it in your Google Cloud Shell:
+[Click this link](https://ssh.cloud.google.com/cloudshell/editor?cloudshell_git_repo=https://github.com/logzio/logzio-google-pubsub
+) to clone the solution's repo and use it in your Google Cloud Shell.
 
-```shell
-https://ssh.cloud.google.com/cloudshell/editor?cloudshell_git_repo=https://github.com/logzio/logzio-google-pubsub
-```
-
-You may encounter a pop up window. Check the `Trust repo` checkbox, and press `Confirm`.
+:::note
+If a pop-up window appears, check the `Trust repo` box and press `Confirm`.
+:::
 
 ### Run setup script in Google Cloud Shell
 
@@ -33,9 +32,18 @@ Replace the variables as per the table below:
 
 | Parameter      | Description                                                                                                                                                                                               |
 | -------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `<<LISTENER-HOST>>`   | Use the listener URL specific to the region of your Logz.io account. You can look it up [here](https://docs.logz.io/user-guide/accounts/account-region.html).                                             |
+| `<<LISTENER-HOST>>`   | Use the listener URL specific to the region of your Logz.io account. You can look it up [here](https://docs.logz.io/docs/user-guide/admin/hosting-regions/account-region/).                                             |
 | `<<LOG-SHIPPING-TOKEN>>`          | The logs' shipping token of the account you want to ship to.                                                                                                                                              |
 | `<<GCP-REGION>>`     | Region where you want to upload Cloud Function. Requires for Deploy to Cloud option for platform.                                                                                                     |
 | `<<LOG-TYPE>>`       | Log type. Help classify logs into different classifications. (Default: `gcp-pubsub`)                                                                                                                       |
 | `<<FUNCTION-NAME>>`  | Function name will be using as Google Cloud Function name. (Default: `logzioHandler`)                                                                                                                      |
-| `<<TELEMETRY-LIST>>` | Will send logs that match the Google resource type. Detailed list you can find [here](https://cloud.google.com/logging/docs/api/v2/resource-list) (ex: `pubsub_topic,pubsub_subscription`). For all services insert `all_services`. |
+| `<<TELEMETRY-LIST>>` | Will send logs that match the Google resource type. Detailed list you can find [here](https://cloud.google.com/logging/docs/api/v2/resource-list) (ex: `pubsub_topic,pubsub_subscription`). For all services insert `all_services`. |
+
+
+#### Updating `telemetry_list` after creation
+
+To update the resources that are monitored by the function follow the steps:
+1. Go to Log router page.
+2. Choose `logzioHandler-sink-logs-to-logzio`.
+3. Edit the sink.
+4. Update the query which filters for the resource types to monitor.
diff --git a/docs/_include/general-shipping/gcp-metrics.md b/docs/_include/general-shipping/gcp-metrics.md
@@ -9,13 +9,12 @@ This integration is based on [`logzio-google-metrics`](https://github.com/logzio
 
 ### Run Google Cloud Shell configuration
 
-Use the following link, to clone the solution's repo and use it in your Google Cloud Shell:
-
-```shell
-https://ssh.cloud.google.com/cloudshell/editor?cloudshell_git_repo=https://github.com/logzio/logzio-google-metrics
-```
+[Click this link](https://ssh.cloud.google.com/cloudshell/editor?cloudshell_git_repo=https://github.com/logzio/logzio-google-metrics
+) to clone the solution's repo and use it in your Google Cloud Shell.
 
+:::note
 You may encounter a pop up window. Check the `Trust repo` checkbox, and press `Confirm`.
+:::
 
 ### Run setup script in Google Cloud Shell
 
@@ -33,7 +32,7 @@ Replace the variables as per the table below:
 
 | Parameter      | Description                                                                                                                                                                                               |
 | -------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `<<LISTENER-HOST>>`   | Use the listener URL specific to the region of your Logz.io account. You can look it up [here](https://docs.logz.io/user-guide/accounts/account-region.html).                                             |
+| `<<LISTENER-HOST>>`   | Use the listener URL specific to the region of your Logz.io account. You can look it up [here](https://docs.logz.io/docs/user-guide/admin/hosting-regions/account-region/).                                             |
 | `<<PROMETHEUS-METRICS-SHIPPING-TOKEN>>`          | The metrics' shipping token of the account you want to ship to.                                                                                                                                              |
 | `<<GCP-REGION>>`     | Region where you want to upload Cloud Function. Requires for Deploy to Cloud option for platform.                                                                                                     |
 | `<<FUNCTION-NAME-PREFIX>>`  | Function name will be using as Google Cloud Function name. (Default: `metrics_gcp`)                                                                                                                      |

diff --git a/docs/_include/general-shipping/k8s-all-data.md b/docs/_include/general-shipping/k8s-all-data.md
@@ -1,27 +1,26 @@
-## All telemetry (logs, metrics, traces and security reports) at once
+## Send All Telemetry Data (logs, metrics, traces and security reports)
 
 
-To enjoy the full Kubernetes 360 experience, you can send all your telemetry data to Logz.io using one single Helm chart:
+Send all of your telemetry data using one single Helm chart:
 
-```sh
-helm repo add logzio-helm https://logzio.github.io/logzio-helm
-helm repo update
+
+```shell
 helm install  -n monitoring --create-namespace \
 --set logs.enabled=true \
---set logzio-logs-collector.secrets.logzioLogsToken="<<LOG-SHIPPING-TOKEN>>" \  
---set logzio-logs-collector.secrets.logzioRegion="<<LOGZIO-REGION>>" \  
---set logzio-logs-collector.secrets.env_id="<<CLUSTER-NAME>>" \  
+--set logzio-logs-collector.secrets.logzioLogsToken="<<LOG-SHIPPING-TOKEN>>" \
+--set logzio-logs-collector.secrets.logzioRegion="<<LOGZIO_ACCOUNT_REGION_CODE>>" \
+--set logzio-logs-collector.secrets.env_id="<<CLUSTER-NAME>>" \
 --set metricsOrTraces.enabled=true \
 --set logzio-k8s-telemetry.metrics.enabled=true \
---set logzio-k8s-telemetry.secrets.MetricsToken="<<PROMETHEUS-METRICS-SHIPPING-TOKEN>>" \
+--set logzio-k8s-telemetry.secrets.MetricsToken="<<METRICS-SHIPPING-TOKEN>>" \
 --set logzio-k8s-telemetry.secrets.ListenerHost="https://<<LISTENER-HOST>>:8053" \
 --set logzio-k8s-telemetry.secrets.p8s_logzio_name="<<ENV-ID>>" \
 --set logzio-k8s-telemetry.traces.enabled=true \
 --set logzio-k8s-telemetry.secrets.TracesToken="<<TRACING-SHIPPING-TOKEN>>" \
---set logzio-k8s-telemetry.secrets.LogzioRegion="<<LOGZIO-REGION>>" \
+--set logzio-k8s-telemetry.secrets.LogzioRegion="<<LOGZIO_ACCOUNT_REGION_CODE>>" \
 --set logzio-k8s-telemetry.spm.enabled=true \
 --set logzio-k8s-telemetry.secrets.env_id="<<ENV-ID>>" \
---set logzio-k8s-telemetry.secrets.SpmToken="<<PROMETHEUS-METRICS-SHIPPING-TOKEN>>" \
+--set logzio-k8s-telemetry.secrets.SpmToken="<<SPM-METRICS-SHIPPING-TOKEN>>" \
 --set logzio-k8s-telemetry.serviceGraph.enabled=true \
 --set logzio-k8s-telemetry.k8sObjectsConfig.enabled=true \
 --set logzio-k8s-telemetry.secrets.k8sObjectsLogsToken="<<LOG-SHIPPING-TOKEN>>" \
@@ -40,9 +39,19 @@ logzio-monitoring logzio-helm/logzio-monitoring
 | --- | --- |
 | `<<LOG-SHIPPING-TOKEN>>` | Your [logs shipping token](https://app.logz.io/#/dashboard/settings/general). |
 | `<<LISTENER-HOST>>` | Your account's [listener host](https://app.logz.io/#/dashboard/settings/manage-tokens/data-shipping?product=logs). |
-| `<<PROMETHEUS-METRICS-SHIPPING-TOKEN>>` | Your [metrics shipping token](https://app.logz.io/#/dashboard/settings/manage-tokens/data-shipping). |
-| `<<P8S-LOGZIO-NAME>>` | The name for the environment's metrics, to easily identify the metrics for each environment. |
+| `<<METRICS-SHIPPING-TOKEN>>` | Your [metrics shipping token](https://app.logz.io/#/dashboard/settings/manage-tokens/data-shipping). |
+| `<<SPM-METRICS-SHIPPING-TOKEN>>` | Your [SPM account shipping token](https://app.logz.io/#/dashboard/settings/manage-tokens/data-shipping) |
 | `<<ENV-ID>>` | The name for your environment's identifier, to easily identify the telemetry data for each environment. |
 | `<<TRACING-SHIPPING-TOKEN>>` | Your [traces shipping token](https://app.logz.io/#/dashboard/settings/manage-tokens/data-shipping). |
-| `<<LOGZIO-REGION>>` | Name of your Logz.io traces region e.g `us`, `eu`... |
+| `<<LOGZIO_ACCOUNT_REGION_CODE>>` | Your Logz.io [region code](https://docs.logz.io/docs/user-guide/admin/hosting-regions/account-region/#available-regions) |
+
 
+:::tip
+To diable metrics when `metricsOrTraces.enabled=true`, make sure to include the below flags in the command:
+
+```shell
+--set logzio-k8s-telemetry.nodeExporter.enabled=false \
+--set logzio-k8s-telemetry.kubeStateMetrics.enabled=false \
+--set logzio-k8s-telemetry.pushGateway.enabled=false \
+```
+:::
-Original file line number
+Diff line change
@@ Expand Up @@
     :::note
     If you don't have a Distributed Tracing account yet, start a trial in the Distributed Tracing tab.
-    <!-- reach out to your account manager or email [the Sales team](mailto:[email protected]).-->
     :::
@@ Expand Down @@