Skip to content

Revert "Docusaurus Faster installation" #4936

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

Merged
merged 5 commits into from
Jan 8, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
408 changes: 1 addition & 407 deletions LICENSE

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/api/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ Sumo Logic has several deployments that are assigned depending on the geographic

Sumo Logic redirects your browser to the correct login URL and also redirects Collectors to the correct endpoint. However, if you're using an API you'll need to manually direct your API client to the correct Sumo Logic API URL.

<table>
<table><small>
<tr>
<td>Deployment</td>
<td>Service Endpoint (login URL)</td>
Expand Down Expand Up @@ -192,7 +192,7 @@ https://endpoint9.collection.us2.sumologic.com/</td>
<td>syslog.collection.us2.sumologic.com</td>
<td>https://open-collectors.us2.sumologic.com</td>
</tr>

</small>
</table>

### Which endpoint should I should use?
Expand Down
4 changes: 3 additions & 1 deletion docs/api/organizations-management.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,9 @@ With the Organizations Management API, you can get the credits usage details of
| JP | https://api.jp.sumologic.com/docs/#tag/orgsManagement |
| KR | https://api.kr.sumologic.com/docs/#tag/orgsManagement |
| US1 | https://api.sumologic.com/docs/#tag/orgsManagement |
| US2 | https://api.us2.sumologic.com/docs/#tag/orgsManagement<br/>https://organizations.sumologic.com/docs/#tag/organizationsManagement* <br/> *This assembly is exclusive to the US2 deployment and is designed to manage APIs for Sumo Logic orgs that are not tied to a specific deployment. For example, a parent organization might have child organizations across different deployments. As a result, the [List Organizations API](https://organizations.sumologic.com/docs/#operation/listOrganizations), which lists child organizations, is included in this assembly to accommodate child organizations spread across multiple deployments. |
| US2 | https://api.us2.sumologic.com/docs/#tag/orgsManagement<br/>https://organizations.sumologic.com/docs/#tag/organizationsManagement <sup>`*`</sup> |

<sup>`*`</sup> This assembly is exclusive to the US2 deployment and manages APIs for Sumo Logic orgs not tied to a specific deployment, such as parent orgs with child orgs across multiple deployments. It includes the [List Organizations API](https://organizations.sumologic.com/docs/#operation/listOrganizations) to support this setup.

<!-- ## Required role capabilities

Expand Down
15 changes: 8 additions & 7 deletions docs/integrations/amazon-aws/aws-privatelink.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,18 +13,18 @@ import useBaseUrl from '@docusaurus/useBaseUrl';

<p><a href="/docs/beta"><span className="beta">Beta</span></a></p>

Sumo Logic provides the ability to configure private connectivity between your AWS Infrastructure and Sumologic via [AWS PrivateLink](https://aws.amazon.com/privatelink). This prevents any traffic from being accessible to the public internet.
Sumo Logic provides the ability to configure private connectivity between your AWS Infrastructure and Sumologic via [AWS PrivateLink](https://aws.amazon.com/privatelink). This prevents any traffic from being accessible to the public internet.

Following sources are supported for AWS PrivateLink:
Following sources are supported for AWS PrivateLink:

- **Installed Collector sources**. Data collected on Installed collectors deployed on customer VPC and sent to Sumo Logic.
- **Sumo Logic OpenTelemetry Distro Collector sources**. Data collected on OpenTelemetry Distro collectors deployed on customer VPC and sent to Sumo Logic.
- **HTTPs sources**. Data sent by the applications hosted in customers VPC and sent over to Sumologic using [HTTP Logs and Metrics Source](/docs/send-data/hosted-collectors/http-source/logs-metrics/) and Kinesis Firehose Source for Logs and Metrics.
- **OTLP Source**. An [OTLP/HTTP Source](/docs/send-data/hosted-collectors/http-source/otlp/) is an endpoint for receiving OTLP-formatted Logs and Metrics from OpenTelemetry collectors using [OTLP exporter](https://github.com/open-telemetry/opentelemetry-collector/tree/v0.99.0/exporter/otlphttpexporter#otlphttp-exporter).
- **OTLP Source**. An [OTLP/HTTP Source](/docs/send-data/hosted-collectors/http-source/otlp/) is an endpoint for receiving OTLP-formatted Logs and Metrics from OpenTelemetry collectors using [OTLP exporter](https://github.com/open-telemetry/opentelemetry-collector/tree/v0.99.0/exporter/otlphttpexporter#otlphttp-exporter).

The following sources are not supported for AWS PrivateLink:
The following sources are not supported for AWS PrivateLink:

- Cloud Syslog
- Cloud Syslog
- AWS S3
- AWS Cloudwatch source
- RUM sources
Expand All @@ -37,7 +37,7 @@ With the NLB-created and ALB-registered as a target, requests over AWS PrivateL

Sumo Logic exposes AWS PrivateLink endpoints to different [regions that depend on your Sumo Logic deployment](/docs/api/getting-started/#sumo-logic-endpoints-by-deployment-and-firewall-security). If you're using the VPC in a different region where the Sumo Logic PrivateLink endpoint service is set up, you need to set up VPC peering. Either way, you need to create an endpoint.

<table>
<table><small>
<tr>
<td><strong>Deployment</strong></td>
<td><strong>Collection Endpoint</strong></td>
Expand Down Expand Up @@ -119,7 +119,8 @@ https://endpoint9.collection.us2.sumologic.com</td>
<td>https://open-collectors.us2.sumologic.com</td>
<td>us-west-2</td>
</tr>
</table>
</small></table>


### Create an endpoint to connect with the Sumo Logic endpoint service

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ This application relies on 45 Scheduled Searches that Save to two different Inde
<details>
<summary>View the list of Scheduled Searches (<strong>click to expand</strong>)</summary>

<table>
<table><small>
<tr>
<td><strong>Folder</strong></td>
<td><strong>Scheduled Search Name (prefixed with gis_benchmarks)</strong></td>
Expand Down Expand Up @@ -282,7 +282,7 @@ This application relies on 45 Scheduled Searches that Save to two different Inde
<td>S3_ListBuckets</td>
<td>Counts S3 events related to listing buckets.</td>
</tr>
</table>
</small></table>

* To reduce false positives, the benchmarks and application filter out AWS CloudTrail events from legitimate cloud services including AWS itself and CloudHealth by VMware.
* Security posture requirements may vary between AWS accounts for a given customer. For example, development accounts might have less strict controls than production accounts. The app supports filtering findings by AWS account ID to facilitate AWS account level posture assessment.
Expand Down
33 changes: 8 additions & 25 deletions docs/integrations/amazon-aws/lambda.md
Original file line number Diff line number Diff line change
Expand Up @@ -200,38 +200,21 @@ To collect the metrics in Sumo Logic, follow the steps below:

Once Provisioned Concurrency is enabled and you start collecting CloudWatch metrics, the following new metrics will be available:

<table>
<tr>
<td>Metric </td>
<td>Description </td>
</tr>
<tr>
<td><strong>ProvisionedConcurrentExecutions</strong> </td>
<td>Concurrent Executions using Provisioned Concurrency </td>
</tr>
<tr>
<td><strong>ProvisionedConcurrencyUtilization</strong> </td>
<td>Fraction of Provisioned Concurrency in use </td>
</tr>
<tr>
<td><strong>ProvisionedConcurrencyInvocations</strong> </td>
<td>Number of Invocations using Provisioned Concurrency </td>
</tr>
<tr>
<td><strong>ProvisionedConcurrencySpilloverInvocations</strong> </td>
<td>Number of Invocations that are above Provisioned Concurrency </td>
</tr>
</table>

| Metric | Description |
|:-----------|:-------------------------|
| **ProvisionedConcurrentExecutions** | Concurrent Executions using Provisioned Concurrency |
| **ProvisionedConcurrencyUtilization** | Fraction of Provisioned Concurrency in use |
| **ProvisionedConcurrencyInvocations** | Number of Invocations using Provisioned Concurrency |
| **ProvisionedConcurrencySpilloverInvocations** | Number of Invocations that are above Provisioned Concurrency |

These metrics can then be queried using Sumo Logic [Metrics queries](/docs/metrics/metrics-queries), as shown in the following example:

<img src={useBaseUrl('img/integrations/amazon-aws/AWS-Lambda-Search-Provisioned-Concurrency-Metrics.png')} alt="Search Provisioned Concurrency Metrics" />

### Field in Field Schema

1. [**Classic UI**](/docs/get-started/sumo-logic-ui-classic). In the main Sumo Logic menu, select **Manage Data > Logs > Fields**. <br/>[**New UI**](/docs/get-started/sumo-logic-ui). In the top menu select **Configuration**, and then under **Logs** select **Fields**. You can also click the **Go To...** menu at the top of the screen and select **Fields**.
1. Search for the “**functionname**” field.
1. [**Classic UI**](/docs/get-started/sumo-logic-ui-classic). In the main Sumo Logic menu, select **Manage Data > Logs > Fields**. <br/>[**New UI**](/docs/get-started/sumo-logic-ui). In the top menu select **Configuration**, and then under **Logs** select **Fields**. You can also click the **Go To...** menu at the top of the screen and select **Fields**.
1. Search for the “**functionname**” field.
1. If not present, create it. Learn how to create and manage fields [here](/docs/manage/fields.md#manage-fields).


Expand Down
4 changes: 2 additions & 2 deletions docs/integrations/app-development/jfrog-artifactory.md
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@ In this step, you configure four local file sources, one for each log source lis

The following suffixes are required. For example, you could use `_sourceCategory=<Foo>/artifactory/console`, but the suffix **artifactory/console** must be used.

<table>
<table><small>
<tr>
<td><strong>Log source</strong></td>
<td><strong>File Path</strong></td>
Expand All @@ -139,7 +139,7 @@ The following suffixes are required. For example, you could use `_sourceCategory
<td>Traffic</td>
<td>$JFROG_HOME/&#60;product&#62;/var/log/artifactory-traffic.*.log</td>
<td>artifactory/traffic</td>
</tr>
</tr></small>
</table>

:::note
Expand Down
59 changes: 13 additions & 46 deletions docs/integrations/app-development/jfrog-xray.md
Original file line number Diff line number Diff line change
Expand Up @@ -228,52 +228,19 @@ Advanced configuration can be used with all JFrog Xray script-based collection c

This section provides a list of variables for Jfrog Xray that you can define in the configuration file.

<table>
<tr>
<td>Variable </td>
<td>Usage </td>
</tr>
<tr>
<td>BACKFILL_DAYS in Collection Section </td>
<td>Number of days before the event collection will start. If the value is 1, then events are fetched from yesterday to today. </td>
</tr>
<tr>
<td>LOG_FORMAT in Logging Section </td>
<td>Log format used by the python logging module to write logs in a file. </td>
</tr>
<tr>
<td>ENABLE_LOGFILE in Logging Section </td>
<td>Set to TRUE to write all logs and errors to a log file. </td>
</tr>
<tr>
<td>ENABLE_CONSOLE_LOG in Logging Section </td>
<td>Enables printing logs in a console. </td>
</tr>
<tr>
<td>LOG_FILEPATH in Logging Section </td>
<td>Path of the log file used when ENABLE_LOGFILE is set to TRUE. </td>
</tr>
<tr>
<td>NUM_WORKERS in Collection Section </td>
<td>Number of threads to spawn for API calls. </td>
</tr>
<tr>
<td>MAX_RETRY in Collection Section </td>
<td>Number of retries to attempt in case of request failure. </td>
</tr>
<tr>
<td>BACKOFF_FACTOR in Collection Section </td>
<td>A backoff factor to apply between attempts after the second try. If the backoff_factor is 0.1, then sleep() will sleep for [0.0s, 0.2s, 0.4s, ...] between retries. </td>
</tr>
<tr>
<td>TIMEOUT in Collection Section </td>
<td>Request time out used by the requests library. </td>
</tr>
<tr>
<td>HTTP_LOGS_ENDPOINT in SumoLogic sectio </td>
<td>HTTP source endpoint url created in Sumo Logic for ingesting Logs. </td>
</tr>
</table>
| Variable | Usage |
|:----|:-----------------------|
| BACKFILL_DAYS in Collection Section | Number of days before the event collection will start. If the value is 1, then events are fetched from yesterday to today. |
| LOG_FORMAT in Logging Section | Log format used by the Python logging module to write logs in a file. |
| ENABLE_LOGFILE in Logging Section | Set to TRUE to write all logs and errors to a log file. |
| ENABLE_CONSOLE_LOG in Logging Section | Enables printing logs in a console. |
| LOG_FILEPATH in Logging Section | Path of the log file used when ENABLE_LOGFILE is set to TRUE. |
| NUM_WORKERS in Collection Section | Number of threads to spawn for API calls. |
| MAX_RETRY in Collection Section | Number of retries to attempt in case of request failure. |
| BACKOFF_FACTOR in Collection Section | A backoff factor to apply between attempts after the second try. If the backoff_factor is 0.1, then sleep() will sleep for [0.0s, 0.2s, 0.4s, ...] between retries. |
| TIMEOUT in Collection Section | Request timeout used by the requests library. |
| HTTP_LOGS_ENDPOINT in Sumo Logic Section | HTTP source endpoint URL created in Sumo Logic for ingesting logs. |


</details>

Expand Down
41 changes: 7 additions & 34 deletions docs/integrations/containers-orchestration/docker-ulm.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ There are alternative methods for collecting Docker logs and metrics. See [Docke

### Add a Docker logs source

1. [**Classic UI**](/docs/get-started/sumo-logic-ui-classic). In the main Sumo Logic menu, select **Manage Data > Collection > Collection**. <br/>[**New UI**](/docs/get-started/sumo-logic-ui). In the Sumo Logic top menu select **Configuration**, and then under **Data Collection** select **Collection**. You can also click the **Go To...** menu at the top of the screen and select **Collection**.
1. [**Classic UI**](/docs/get-started/sumo-logic-ui-classic). In the main Sumo Logic menu, select **Manage Data > Collection > Collection**. <br/>[**New UI**](/docs/get-started/sumo-logic-ui). In the Sumo Logic top menu select **Configuration**, and then under **Data Collection** select **Collection**. You can also click the **Go To...** menu at the top of the screen and select **Collection**.
2. Navigate to the collector you installed on the Docker host, and select **Add > Add Source**.
3. Select **Docker Logs**. The Docker Logs page appears.
4. Configure the source fields:
Expand Down Expand Up @@ -91,7 +91,7 @@ There are alternative methods for collecting Docker logs and metrics. See [Docke

### Add a Docker Stats Source

1. [**Classic UI**](/docs/get-started/sumo-logic-ui-classic). In the main Sumo Logic menu, select **Manage Data > Collection > Collection**. <br/>[**New UI**](/docs/get-started/sumo-logic-ui). In the Sumo Logic top menu select **Configuration**, and then under **Data Collection** select **Collection**. You can also click the **Go To...** menu at the top of the screen and select **Collection**.
1. [**Classic UI**](/docs/get-started/sumo-logic-ui-classic). In the main Sumo Logic menu, select **Manage Data > Collection > Collection**. <br/>[**New UI**](/docs/get-started/sumo-logic-ui). In the Sumo Logic top menu select **Configuration**, and then under **Data Collection** select **Collection**. You can also click the **Go To...** menu at the top of the screen and select **Collection**.
2. Navigate to the collector you installed on the Docker host, and select **Add > Add Source**.
3. Select **Docker Stats.** The following Docker Stats page appears. There are two possible content types available, select **Metrics** to collect data as metrics, or select **Logs** (JSON) to collect data as JSON logs. To collect metrics for the Docker ULM app, select **Metrics** as the Content Type.
4. Configure the source fields:
Expand Down Expand Up @@ -491,38 +491,11 @@ The table below defines the types of variables you can use.

Docker engine event log data doesn't support the tagging with metadata.

<table>
<tr>
<td><strong>Namespace/VAR_TYPE</strong> </td>
<td><strong>Description</strong> </td>
<td><strong>VAR_NAME</strong> </td>
</tr>
<tr>
<td><code>container</code> </td>
<td>Container metadata fields provided by Docker for use in the <code>--log-opt</code> tag option.
<br/>These are automatically added to data points.
<br/>For more information, see <a href="https://docs.docker.com/engine/admin/logging/log_tags/">Log tags for logging driver</a> in Docker help.</td>
<td><code>ID</code> The first 12 characters of the container ID.
<br/><code>FullID</code> The full container ID.
<br/><code>Name</code> The container name.
<br/><code>ImageID</code> The first 12 characters of the container’s image ID.
<br/><code>ImageFullID</code> The container’s full image ID.
<br/><code>ImageName</code> The name of the image used by the container. </td>
</tr>
<tr>
<td><code>label</code> </td>
<td>User-defined labels, supplied with the <code>--label flag</code> when starting a Docker container.
<br/>This is automatically added to data points. </td>
<td>The name of the variable.
<br/>Dot characters (<code>.</code>) are not supported. </td>
</tr>
<tr>
<td><code>env</code> </td>
<td>User-defined container environment variables that are set with <code>--env|-e</code> flags when starting a container. </td>
<td>The name of the variable.
<br/>Dot characters (<code>.</code>) are not supported. </td>
</tr>
</table>
| Namespace/VAR_TYPE | Description | VAR_NAME |
|:--------------------|:------------------------------|:------------|
| `container` | Container metadata fields provided by Docker for use in the `--log-opt` tag option.<br/>These are automatically added to data points.<br/>For more information, see [Log tags for logging driver](https://docs.docker.com/engine/admin/logging/log_tags/) in Docker help. | `ID`: The first 12 characters of the container ID.<br/>`FullID`: The full container ID.<br/>`Name`: The container name.<br/>`ImageID`: The first 12 characters of the container’s image ID.<br/>`ImageFullID`: The container’s full image ID.<br/>`ImageName`: The name of the image used by the container. |
| `label` | User-defined labels, supplied with the `--label` flag when starting a Docker container.<br/>This is automatically added to data points. | The name of the variable.<br/>Dot characters (`.`) are not supported. |
| `env` | User-defined container environment variables that are set with `--env\|-e` flags when starting a container. | The name of the variable.<br/>Dot characters (`.`) are not supported. |


For example:
Expand Down
Loading
Loading