Skip to content

Commit 60d13d9

Browse files
committed
Update doc
1 parent ad04914 commit 60d13d9

File tree

5 files changed

+76
-50
lines changed

5 files changed

+76
-50
lines changed

docs/integrations/saas-cloud/acquia.md

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -190,10 +190,20 @@ Be sure to copy and paste your **token** in a secure location. You'll need this
190190

191191
**Sumo Logic SSL certificate**
192192

193-
In the procedure below, you'll configure a Cloud Syslog Source. This will generate a Sumo Logic token and the endpoint hostname. Then you'll set up TLS by downloading a cert to your server. Download the DigiCert certificate from one of the following locations:
194-
* [https://www.digicert.com/CACerts/DigiCertHighAssuranceEVRootCA.crt](https://www.digicert.com/CACerts/DigiCertHighAssuranceEVRootCA.crt)
195-
* [https://www.digicert.com/CACerts/DigiCertHighAssuranceEVRootCA.crt.pem](https://www.digicert.com/CACerts/DigiCertHighAssuranceEVRootCA.crt.pem)
196-
193+
In the procedure below, you'll configure a Cloud Syslog Source. This will generate a Sumo Logic token and the endpoint hostname. Then you'll set up TLS by downloading a cert to your server.
194+
195+
1. Download the DigiCert and AWS Certificate Manager (ACM) certificates from the following locations:
196+
* https://www.digicert.com/CACerts/DigiCertHighAssuranceEVRootCA.crt
197+
* https://www.digicert.com/CACerts/DigiCertHighAssuranceEVRootCA.crt.pem
198+
* https://www.amazontrust.com/repository/AmazonRootCA1.cer
199+
1. Run the following commands:
200+
* `wget -O digicert_ca.der https://cacerts.digicert.com/DigiCertHighAssuranceEVRootCA.crt.`
201+
* `openssl x509 -inform der -in digicert_ca.der -out digicert_ca.crt`
202+
* `wget -O acm_ca.der https://www.amazontrust.com/repository/AmazonRootCA1.cer`
203+
* `openssl x509 -inform der -in acm_ca.der -out acm_ca.crt`
204+
* `cat acm_ca.crt digicert_ca.crt > digicert_acm_cas.crt`
205+
* `perl -p -i -e "s/\r//g" digicert_acm_cas.crt`
206+
1. Upload the merged cert to the Acquia app.
197207

198208
### Configuring a cloud syslog source
199209

docs/send-data/collect-from-other-data-sources/collect-logs-sentinelone.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -28,13 +28,17 @@ To get a token and certificate from Sumo Logic, do the following:
2828

2929
1. Configure a Cloud Syslog [Hosted Collector](/docs/send-data/collector-faq/#configure-limits-for-collector-caching) and [Cloud Syslog Source](/docs/send-data/hosted-collectors/cloud-syslog-source), and generate a Cloud Syslog source token. 
3030

31-
1. Download the crt server certificate file from [here](https://www.digicert.com/CACerts/DigiCertHighAssuranceEVRootCA.crt).
31+
1. Download the server certificate files from https://www.digicert.com/CACerts/DigiCertHighAssuranceEVRootCA.crt and https://www.amazontrust.com/repository/AmazonRootCA1.cer.
3232

33-
1. Go to the location where the cert file is located and open a terminal window.
33+
1. Go to the location where the cert files are located and open a terminal window.
3434

35-
1. Run the following two commands:
36-
* `wget -O digicert_ca.der https://cacerts.digicert.com/DigiCertHighAssuranceEVRootCA.crt.`
37-
* `openssl x509 -inform der -in digicert_ca.der -out digicert_ca.crt`
35+
1. Run the following commands:
36+
* `wget -O digicert_ca.der https://cacerts.digicert.com/DigiCertHighAssuranceEVRootCA.crt.`
37+
* `openssl x509 -inform der -in digicert_ca.der -out digicert_ca.crt`
38+
* `wget -O acm_ca.der https://www.amazontrust.com/repository/AmazonRootCA1.cer`
39+
* `openssl x509 -inform der -in acm_ca.der -out acm_ca.crt`
40+
* `cat acm_ca.crt digicert_ca.crt > digicert_acm_cas.crt`
41+
* `perl -p -i -e "s/\r//g" digicert_acm_cas.crt`
3842

3943
## Step 2. Configure syslog messages
4044

@@ -54,7 +58,7 @@ To configure syslog messages, do the following:
5458
1. Click **SYSLOG**. The SYSLOG dialog appears.
5559
1. Click the toggle to **Enable SYSLOG**.
5660
1. Enter the **Syslog Host URL** and **port** number.
57-
1. Click **Use SSL secure connection**, then click **Server certificate > Upload** and browse to the location of the downloaded crt certificate file.
61+
1. Click **Use SSL secure connection**, then click **Server certificate > Upload** and browse to the location of the merged crt certificate file.
5862
1. Specify the following **Formatting** options:
5963

6064
* **Information format**: Select **CEF2**

docs/send-data/hosted-collectors/cloud-syslog-source/index.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ You can configure a cloud syslog source to allow a syslog client to send [RFC 5
1313

1414
Syslog messages must be compliant with [RFC 5424](https://tools.ietf.org/html/rfc5424) or they are dropped. Messages over 64 KB are truncated.
1515

16-
Sumo manages an elastic scaling set of syslog servers, which scales up and down behind a set of AWS Elastic Load Balancers. The AWS ELB set can also scale up and down. For this reason, instead of IP address-based endpoints, Sumo uses endpoint hostnames in this format:
16+
Sumo Logic manages an elastic scaling set of syslog servers, which scales up and down behind a set of AWS Elastic Load Balancers. The AWS ELB set can also scale up and down. For this reason, instead of IP address-based endpoints, Sumo Logic uses endpoint hostnames in this format:
1717

1818
```
1919
syslog.collection.YOUR_DEPLOYMENT.sumologic.com
@@ -25,17 +25,17 @@ where `YOUR_DEPLOYMENT` is `au`, `ca`, `de`, `eu`, `fed`, `jp`, `kr`, `us1`,
2525
FIPS 140-2 compliance is not available for Cloud Syslog in the FedRAMP deployment. It is with great emphasis that you must recognize and understand that the responsibility to mitigate information spillage is solely yours. We have no insight into your data or how it is classified.
2626
:::
2727

28-
In the procedure below, you configure a Cloud Syslog Source, this will generate a Sumo Logic token and the endpoint hostname. Then you set up TLS by downloading a cert to your server. Download the **DigiCert** certificate
29-
from one of the following locations:
30-
* [https://cacerts.digicert.com/DigiCertHighAssuranceEVRootCA.crt](https://cacerts.digicert.com/DigiCertHighAssuranceEVRootCA.crt)
31-
* [https://cacerts.digicert.com/DigiCertHighAssuranceEVRootCA.crt.pem](https://cacerts.digicert.com/DigiCertHighAssuranceEVRootCA.crt.pem)
28+
In the procedure below, you configure a Cloud Syslog Source. This will generate a Sumo Logic token and the endpoint hostname. Then you set up TLS by downloading a cert to your server. Download the DigiCert and AWS Certificate Manager (ACM) certificates from the following locations:
29+
* https://cacerts.digicert.com/DigiCertHighAssuranceEVRootCA.crt
30+
* https://cacerts.digicert.com/DigiCertHighAssuranceEVRootCA.crt.pem
31+
* https://www.amazontrust.com/repository/AmazonRootCA1.cer
3232

3333
Sumo Logic supports syslog clients, including syslog-ng and rsyslog. Follow the instructions in the appropriate section below to configure your server to send syslog data. If syslog data does not appear in Sumo Logic, refer to
3434
[Troubleshooting](#troubleshooting) below.
3535

3636
## Configure a Cloud Syslog Source
3737

38-
Cloud syslog configuration requires a token that is automatically generated when you configure a cloud syslog source. The token allows Sumo to distinguish your log messages from those of other customers. The token is tied to the source, but not to any specific user. 
38+
Cloud syslog configuration requires a token that is automatically generated when you configure a cloud syslog source. The token allows Sumo Logic to distinguish your log messages from those of other customers. The token is tied to the source, but not to any specific user. 
3939

4040
Include the token as the [Structured ID](https://tools.ietf.org/html/rfc5424#section-7) in every syslog message that is sent to Sumo Logic. The token is removed by Sumo Logic during ingestion and is not included with your syslog message in search results.
4141

@@ -46,18 +46,18 @@ To configure a cloud syslog source, do the following:
4646
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**.
4747
1. On the **Collection** page, click **Add Source** next to a Hosted Collector. See [Set up a Hosted Collector](/docs/send-data/hosted-collectors/configure-hosted-collector) for information on adding Hosted Collectors.
4848
1. Select **Cloud Syslog**.
49-
1. Enter a **Name** to display for this source in Sumo. Description is optional.
49+
1. Enter a **Name** to display for this source in Sumo Logic. Description is optional.
5050
1. (Optional) For **Source Host** and **Source Category**, enter any string to tag the output collected from this source. (Category metadata is stored in a searchable field called `_sourceCategory`.)
5151
1. **Fields.** Click the **+Add Field** link to define the fields you want to associate, each field needs a name (key) and value.
5252

5353
* ![green check circle.png](/img/reuse/green-check-circle.png) A green circle with a check mark is shown when the field exists in the Fields table schema.
54-
* ![orange exclamation point.png](/img/reuse/orange-exclamation-point.png) An orange triangle with an exclamation point is shown when the field doesn't exist in the Fields table schema. In this case, an option to automatically add the nonexistent fields to the Fields table schema is provided. If a field is sent to Sumo that does not exist in the Fields schema it is ignored, known as dropped.
54+
* ![orange exclamation point.png](/img/reuse/orange-exclamation-point.png) An orange triangle with an exclamation point is shown when the field doesn't exist in the Fields table schema. In this case, an option to automatically add the nonexistent fields to the Fields table schema is provided. If a field is sent to Sumo Logic that does not exist in the Fields schema it is ignored, known as dropped.
5555

5656
1. Set any of the following under **Advanced**:
5757

5858
* **Enable Timestamp Parsing**. This option is selected by default. If it's deselected, no timestamp information is parsed.
5959
* **Time Zone**. There are two options for Time Zone. You can use the time zone present in your log files, and then choose an option in case time zone information is missing from a log message. Or, you can have Sumo Logic completely disregard any time zone information present in logs by forcing a time zone. It's important to have the proper time zone set, no matter which option you choose. If the time zone of logs cannot be determined, Sumo Logic assigns the UTC time zone; if the rest of your logs are from another time zone your search results will be affected.
60-
* **Timestamp Format**. By default, Sumo will automatically detect the timestamp format of your logs. However, you can manually specify a timestamp format for a source. See [Timestamps, Time Zones, and Time Ranges, and Date Formats](/docs/send-data/reference-information/time-reference).
60+
* **Timestamp Format**. By default, Sumo Logic will automatically detect the timestamp format of your logs. However, you can manually specify a timestamp format for a source. See [Timestamps, Time Zones, and Time Ranges, and Date Formats](/docs/send-data/reference-information/time-reference).
6161

6262
1. Create any Processing Rules you'd like for the new source.
6363
1. Click **Save**. The token information is displayed in a read-only dialog box, shown below.
@@ -69,7 +69,7 @@ To configure a cloud syslog source, do the following:
6969
Token: 9HFxoa6+lXBmvSM9koPjGzvTaxXDQvJ4POE/WCURPAo+w4H7PmZm8H3mSEKxPl0Q@41123, Host: syslog.collection.YOUR_DEPLOYMENT.sumologic.com, TCP TLS Port: 6514
7070
```
7171
72-
The number `41123` in the token is the Sumo Private Enterprise Number (PEN). There are two options for including the token. You can include it in the structured data field or in the message body.  In the following example, the token is in the structured data field. 
72+
The number `41123` in the token is the Sumo Logic Private Enterprise Number (PEN). There are two options for including the token. You can include it in the structured data field or in the message body.  In the following example, the token is in the structured data field. 
7373
7474
```
7575
<165>1 2015-01-11T22:14:15.003Z mymachine.example.com evntslog - ID47 [YOUR_TOKEN] msg
@@ -120,11 +120,11 @@ If syslog messages fail to authenticate to the syslog cloud source—for example
120120
121121
### Troubleshooting
122122
123-
If you encounter problems, follow the instructions below to first verify the Sumo service connection, and then check the client configuration is correct.
123+
If you encounter problems, follow the instructions below to first verify the Sumo Logic service connection, and then check the client configuration is correct.
124124
125-
#### Verify connection with Sumo service
125+
#### Verify connection with Sumo Logic service
126126
127-
To verify that the Sumo service can receive syslog messages, use a networking utility that supports TLS, such as nMap.org's ncat, to check that the syslog port accepts messages. 
127+
To verify that the Sumo Logic service can receive syslog messages, use a networking utility that supports TLS, such as nMap.org's ncat, to check that the syslog port accepts messages. 
128128
129129
```
130130
$ ncat --ssl syslog.collection.YOUR_DEPLOYMENT.sumologic.com PORT
@@ -142,7 +142,7 @@ Then, enter a test message, for example:
142142
<165>1 2017-10-24T06:00:15.003Z mymachine.example.com evntslog - ID47 - YOUR_TOKEN This is a message
143143
```
144144
145-
where `YOUR_TOKEN` is the token that Sumo generated when you created the Cloud Syslog Source above.
145+
where `YOUR_TOKEN` is the token that Sumo Logic generated when you created the Cloud Syslog Source above.
146146
147147
#### Verify client configuration
148148

docs/send-data/hosted-collectors/cloud-syslog-source/rsyslog.md

Lines changed: 22 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -12,25 +12,28 @@ Sumo Logic supports syslog clients such as rsyslog. This document has instructi
1212

1313
Set up Transport Layer Security (TLS).
1414

15-
Download the **DigiCert** certificate from https://cacerts.digicert.com/DigiCertHighAssuranceEVRootCA.crt.
15+
Download the DigiCert and ACM certificates from https://cacerts.digicert.com/DigiCertHighAssuranceEVRootCA.crt and
16+
https://www.amazontrust.com/repository/AmazonRootCA1.cer.
1617

1718
### rsyslog
1819

19-
To set up your **DigiCert** certificate follow these steps:
20+
To set up your DigiCert and AWS Certificate Manager (ACM) certificate, follow these steps:
2021

2122
```bash
2223
$ cd /etc/rsyslog.d/keys/ca.d
2324
$ wget -O digicert_ca.der https://www.digicert.com/CACerts/DigiCertHighAssuranceEVRootCA.crt
2425
$ openssl x509 -inform der -in digicert_ca.der -out digicert_ca.crt
26+
$ wget -O acm_ca.der https://www.amazontrust.com/repository/AmazonRootCA1.cer
27+
$ openssl x509 -inform der -in acm_ca.der -out acm_ca.crt
28+
$ cat acm_ca.crt digicert_ca.crt > digicert_acm_cas.crt
29+
$ perl -p -i -e "s/\r//g" digicert_acm_cas.crt
2530
```
2631

2732
### Send data to a Cloud Syslog Source with rsyslog
2833

2934
This section shows how to configure a syslog client using rsyslog that will send the syslog message to be received by the Sumo Logic Cloud syslog service. If you are new to rsyslog, follow the [rsyslog documentation](http://www.rsyslog.com/doc/v8-stable/installation/index.html) to install.
3035

31-
After rsyslog is installed, edit the configuration file to start sending
32-
logs to Sumo. The configuration file is located at`/etc/rsyslog.conf` by
33-
default. 
36+
After rsyslog is installed, edit the configuration file to start sending logs to Sumo Logic. The configuration file is located at `/etc/rsyslog.conf` by default.
3437

3538
**For rsyslog v7 and earlier**
3639

@@ -44,7 +47,7 @@ $ActionQueueType LinkedList # run asynchronously
4447
$ActionResumeRetryCount -1 # infinite retries if host is down
4548

4649
# RsyslogGnuTLS
47-
$DefaultNetstreamDriverCAFile /etc/rsyslog.d/keys/ca.d/digicert_ca.crt
50+
$DefaultNetstreamDriverCAFile /etc/rsyslog.d/keys/ca.d/digicert_acm_cas.crt
4851
$ActionSendStreamDriver gtls
4952
$ActionSendStreamDriverMode 1
5053
$ActionSendStreamDriverAuthMode x509/name
@@ -55,7 +58,9 @@ template(name="SumoFormat" type="string" string="<%pri%>%protocol-version% %time
5558
*.* action(type="omfwd" protocol="tcp" target="syslog.collection.YOUR_DEPLOYMENT.sumologic.com" port="6514" template="SumoFormat")
5659
```
5760

58-
In the template statement, be sure to replace `YOUR_TOKEN` with your actual token, and `YOUR_DEPLOYMENT` with your deployment. Properties in the string begin and end with '%'. All other texts and white space are treated literally. For more information about rsyslog configuration, see the [rsyslog template documentation](http://www.rsyslog.com/doc/v7-stable/configuration/templates.html) or the [rsyslog omfwd documentation](http://www.rsyslog.com/doc/v7-stable/configuration/modules/omfwd.html).
61+
In the template statement, be sure to replace `YOUR_TOKEN` with your actual token, and `YOUR_DEPLOYMENT` with your deployment. Properties in the string begin and end with '%'. All other texts and white space are treated literally. For more information about rsyslog configuration, see the [rsyslog template documentation](https://www.rsyslog.com/doc/configuration/templates.html) or the [rsyslog omfwd documentation](https://www.rsyslog.com/doc/configuration/modules/omfwd.html).
62+
63+
In the template statement, be sure to replace YOUR_TOKEN with your actual token, and YOUR_DEPLOYMENT with your deployment. Properties in the string begin and end with '%'. All other texts and white space are treated literally. For more information about rsyslog configuration, see the rsyslog template documentation or the rsyslog omfwd documentation.
5964

6065
**For rsyslog v8 and later**
6166

@@ -69,19 +74,19 @@ $ActionQueueType LinkedList # run asynchronously
6974
$ActionResumeRetryCount -1 # infinite retries if host is down
7075

7176
# RsyslogGnuTLS
72-
$DefaultNetstreamDriverCAFile /etc/rsyslog.d/keys/ca.d/digicert_ca.crt
77+
$DefaultNetstreamDriverCAFile /etc/rsyslog.d/keys/ca.d/digicert_acm_cas.crt
7378

7479
template(name="SumoFormat" type="string" string="<%pri%>%protocol-version% %timestamp:::date-rfc3339% %HOSTNAME% %app-name% %procid% %msgid% [YOUR_TOKEN] %msg%\n")
7580

7681
action(type="omfwd"
77-
protocol="tcp"
78-
target="syslog.collection.YOUR_DEPLOYMENT.sumologic.com"
79-
port="6514"
80-
template="SumoFormat"
81-
StreamDriver="gtls"
82-
StreamDriverMode="1"
83-
StreamDriverAuthMode="x509/name"
84-
StreamDriverPermittedPeers="syslog.collection.*.sumologic.com")
82+
protocol="tcp"
83+
target="syslog.collection.YOUR_DEPLOYMENT.sumologic.com"
84+
port="6514"
85+
template="SumoFormat"
86+
StreamDriver="gtls"
87+
StreamDriverMode="1"
88+
StreamDriverAuthMode="x509/name"
89+
StreamDriverPermittedPeers="syslog.collection.*.sumologic.com")
8590
```
8691

87-
In the template statement, be sure to replace `YOUR_TOKEN` with your actual token, and `YOUR_DEPLOYMENT` with your deployment. Properties in the string begin and end with '%'. All other texts and white space are treated literally. For more information about rsyslog configuration, see the [rsyslog template documentation](http://www.rsyslog.com/doc/master/configuration/templates.html) or the [rsyslog omfwd documentation](http://www.rsyslog.com/doc/master/configuration/modules/omfwd.html).
92+
In the template statement, be sure to replace `YOUR_TOKEN` with your actual token, and `YOUR_DEPLOYMENT` with your deployment. Properties in the string begin and end with '%'. All other texts and white space are treated literally. For more information about rsyslog configuration, see the [rsyslog template documentation](https://www.rsyslog.com/doc/configuration/templates.html) or the [rsyslog omfwd documentation](https://www.rsyslog.com/doc/configuration/modules/omfwd.html).

0 commit comments

Comments
 (0)