You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The JFrog Xray app provides visibility into the state of artifacts and components in your JFrog Artifactory repository. The pre-configured dashboards present information about issues detected in your software components in Artifactory, including vulnerable containers, artifacts and components; license and security issues; and top Common Vulnerabilities and Exposures (CVEs). The app also helps identify all incoming threats detected via Sumo Logic Threat Intel.
14
15
15
16
The Sumo Logic app for JFrog Xray and collection are tested on JFrog Xray 2.9.0 version.
16
17
17
-
18
18
## Log types
19
19
20
20
The JFrog Xray app uses the following log types:
@@ -23,8 +23,6 @@ The JFrog Xray app uses the following log types:
23
23
* Artifactory logs. For more information, see [Collecting logs](/docs/integrations/app-development/jfrog-artifactory/#collecting-logs).
24
24
* Kubernetes logs. For more information, see [Collecting Metrics and Logs for the Kubernetes app](/docs/integrations/containers-orchestration/kubernetes#collecting-metrics-and-logs-for-the-kubernetes-app).
25
25
26
-
27
-
28
26
### Sample log messages
29
27
30
28
@@ -71,8 +69,6 @@ The JFrog Xray app uses the following log types:
71
69
}
72
70
```
73
71
74
-
75
-
76
72
### Sample queries
77
73
78
74
The sample query is from Watches Invoked panel of the **JFrog Xray - Overview** dashboard.
| count_distinct(WatchName) as %"Number of Watches"
91
87
```
88
+
## Collection configuration and app installation
89
+
90
+
Choose one of the following methods to configure the JFrog Xray source and install the app:
91
+
92
+
<Tabs
93
+
className="unique-tabs"
94
+
defaultValue="Cloud-to-cloud source setup and app installation"
95
+
values={[
96
+
{label: 'Cloud-to-cloud source setup and app installation', value: 'Cloud-to-cloud source setup and app installation'},
97
+
{label: 'HTTP source setup and app installation', value: 'HTTP source setup and app installation'}
98
+
]}>
99
+
100
+
<TabItemvalue="Cloud-to-cloud source setup and app installation">
101
+
102
+
import CollectionConfiguration from '../../reuse/apps/collection-configuration.md';
103
+
104
+
<CollectionConfiguration/>
105
+
106
+
:::important
107
+
Use the [Cloud-to-Cloud Integration for JFrog Xray](/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/jfrog-xray-source/) to create the source and use the same source category while installing the app. By following these steps, you can ensure that your JFrog Xray app is properly integrated and configured to collect and analyze your JFrog Xray data.
108
+
:::
109
+
110
+
### Create a new collector and install the app
111
+
112
+
import AppCollectionOPtion1 from '../../reuse/apps/app-collection-option-1.md';
113
+
114
+
<AppCollectionOPtion1/>
115
+
116
+
### Use an existing collector and install the app
117
+
118
+
import AppCollectionOPtion2 from '../../reuse/apps/app-collection-option-2.md';
92
119
93
-
## Collecting logs for JFrog Xray
120
+
<AppCollectionOPtion2/>
121
+
122
+
### Use an existing source and install the app
123
+
124
+
import AppCollectionOPtion3 from '../../reuse/apps/app-collection-option-3.md';
125
+
126
+
<AppCollectionOPtion3/>
127
+
128
+
</TabItem>
129
+
130
+
<TabItemvalue="HTTP source setup and app installation">
94
131
95
132
This section explains how to collect logs from JFrog Xray and ingest them into Sumo Logic for use with the JFrog Xray pre-defined dashboards and searches. To get the most of out this app, we recommend you also collect logs from Artifactory as well as Kubernetes.
96
133
@@ -104,21 +141,18 @@ Collect the following details:
104
141
* Port = **8000**
105
142
* Your Username and Password for your JFrog Xray instance
106
143
107
-
108
144
### Step 2: Collect Artifactory logs
109
145
110
146
We recommend collecting data from JFrog Artifactory so as to investigate sources of vulnerable artifacts and who is using them. This is done by correlating Xray logs with Artifactory logs.
111
147
112
148
To do so, follow the instructions in [Collect Logs for Artifactory](/docs/integrations/app-development/jfrog-artifactory#collecting-logs).
113
149
114
-
115
150
### Step 3: Collect Kubernetes logs
116
151
117
152
If you have set up a Docker repository in Artifactory and are running containers in a Kubernetes cluster, we recommend collecting data from your Kubernetes cluster so as to understand all vulnerable containers running in production.
118
153
119
154
To perform this setup, follow the instructions in [Collect Logs for Kubernetes](/docs/integrations/containers-orchestration/kubernetes#collecting-metrics-and-logs-for-the-kubernetes-app).
120
155
121
-
122
156
### Step 4: Add Hosted Collector and HTTP Source
123
157
124
158
In this step you set up a hosted Sumo Logic collector and HTTP source to collect JFrog Xray logs.
@@ -131,7 +165,6 @@ To add a hosted collector and HTTP source:
131
165
1. Create a new Sumo Logic hosted collector by performing the steps in [Configure a Hosted Collector](/docs/send-data/hosted-collectors/configure-hosted-collector).
132
166
2. Create a new HTTP source on the hosted collector created above by following instructions in [HTTP Logs and Metrics Source]](/docs/send-data/hosted-collectors/http-source/logs-metrics).
133
167
134
-
135
168
### Step 5: Set up a collection method for JFrog Xray
136
169
137
170
This section covers the various ways in which to collect logs from JFrog Xray and send them to Sumo Logic. The logs are then shown in dashboards as part of the JFrog Xray App. You can configure a Sumo Logic collector for JFrog Xray in Amazon Web Services (AWS) using AWS Lambda service, or use a script on a Linux machine with a cron job. Choose the method that best suits your environment:
@@ -144,18 +177,15 @@ In this collection method, you deploy the SAM application, which creates the nec
144
177
To deploy the Sumo Logic JFrog xray SAM Application, do the following:
145
178
146
179
1. Go to [https://serverlessrepo.aws.amazon.com/applications](https://serverlessrepo.aws.amazon.com/applications).
147
-
2. Search for **sumologic-jfrog-xray** and make sure the checkbox **Show apps that create custom IAM roles or resource policies** is checked, and click the app link when it appears.
148
-
180
+
1. Search for **sumologic-jfrog-xray** and make sure the checkbox **Show apps that create custom IAM roles or resource policies** is checked, and click the app link when it appears.
149
181
1. When the page for the Sumo app appears, click **Deploy**.
150
-
2. Go to the **AWS Lambda > Functions >****Application Settings** panel, and enter parameters for the following fields:
151
-
***HTTPLogsEndpoint**: Copy and paste the URL for the HTTP log source from [Step 4](#step-4-add-hosted-collector-and-http-source).
152
-
***Hostname**: Copy and paste the Hostname from [Step 1](#step-1-collect-jfrog-xray-instance-details).
153
-
***Port**: Copy and paste the Port from [Step 1](#step-1-collect-jfrog-xray-instance-details).
154
-
***Username**: Copy and paste the Username from [Step 1](#step-1-collect-jfrog-xray-instance-details).
155
-
***Password**: Copy and paste the Password from [Step 1](#step-1-collect-jfrog-xray-instance-details).
156
-
157
-
1. Click **Deploy.**
158
-
182
+
1. Go to the **AWS Lambda > Functions >****Application Settings** panel, and enter parameters for the following fields:
183
+
***HTTPLogsEndpoint**. Copy and paste the URL for the HTTP log source from [Step 4](#step-4-add-hosted-collector-and-http-source).
184
+
***Hostname**. Copy and paste the Hostname from [Step 1](#step-1-collect-jfrog-xray-instance-details).
185
+
***Port**. Copy and paste the Port from [Step 1](#step-1-collect-jfrog-xray-instance-details).
186
+
***Username**. Copy and paste the Username from [Step 1](#step-1-collect-jfrog-xray-instance-details).
187
+
***Password**. Copy and paste the Password from [Step 1](#step-1-collect-jfrog-xray-instance-details).
* A Linux machine compatible with either Python 3.7 or Python 2.7
184
214
185
-
186
215
#### Step 1. Configure the script on a Linux machine
187
216
188
217
This task shows you how to install the script on a Linux machine.
@@ -191,29 +220,27 @@ For Python 3 you will use pip3 install **sumologic-jfrog-xray** (step 3 in the f
191
220
192
221
To deploy the script, do the following:
193
222
1. If **pip** is not already installed, follow the instructions in the [pip documentation](https://pip.pypa.io/en/stable/installing/) to download and install **pip**.
194
-
2. Log in to a Linux machine compatible with either Python 3.7 or Python 2.7.
195
-
3. Do one of the following:
196
-
* For Python 2 - run the following command:
223
+
1. Log in to a Linux machine compatible with either Python 3.7 or Python 2.7.
224
+
1. Do one of the following:
225
+
* For Python 2 - run the following command:
197
226
```bash
198
227
pip install sumologic-jfrog-xray
199
228
```
200
-
* For Python 3 - run the following command:
229
+
* For Python 3 - run the following command:
201
230
```bash
202
231
pip3 install sumologic-jfrog-xray
203
232
```
204
-
1. Create a configuration file **jfrogxraycollector.yaml** in the home directory as shown below, and fill in the parameter `<Variables>` where indicated.
205
-
206
-
1. Create a cron job to run the collector every 5 minutes, (use the crontab -e option), in one of the following ways:
207
-
* For Python 2 - add the following line in your crontab:
233
+
4. Create a configuration file **jfrogxraycollector.yaml** in the home directory as shown below, and fill in the parameter `<Variables>` where indicated.
234
+
5. Create a cron job to run the collector every 5 minutes, (use the crontab -e option), in one of the following ways:
235
+
* For Python 2 - add the following line in your crontab:
0 commit comments