Skip to content

Commit e7f0ae4

Browse files
committed
Fix: reinstate sumo logic docs.
1 parent e5bcc0d commit e7f0ae4

File tree

1 file changed

+88
-0
lines changed

1 file changed

+88
-0
lines changed

jekyll/_cci2/insights.md

Lines changed: 88 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -101,6 +101,94 @@ The per-project insights page gives you access to the build status and build per
101101

102102
- **Build Performance:** The Build Performance graph aggregates your build/job data for a particular day and plots the median for that day going back as far as 90 days. Monitor the performance of your repo by clicking a particular branch.
103103

104+
105+
## Sumo Logic Integration
106+
107+
Sumo Logic users may track and visualize analytical data across all of their
108+
jobs on CircleCI. To do so, use the Sumo Logic Orb and Sumo Logic app
109+
integration from the Sumo Logic partner integrations site.
110+
111+
112+
### The CircleCI Dashboard for Sumo Logic
113+
114+
![header]({{ site.baseurl }}/assets/img/docs/CircleCI_SumoLogic_Dashboard.png)
115+
116+
Included panels:
117+
118+
- Total Job
119+
- Total Successful Jobs
120+
- Total Failed Jobs
121+
- Job Outcome
122+
- Average Runtime in Seconds (by Job)
123+
- Jobs By Projects
124+
- Recent Jobs (latest 10)
125+
- Top 10 Slowest Failed Jobs In Seconds
126+
- Top 10 Slowest Successful Jobs In Seconds
127+
128+
Install the CircleCI dashboard by using the App Catalog from the dashboard home page.
129+
130+
![header]({{ site.baseurl }}/assets/img/docs/sumologic_app_catalog.png)
131+
132+
This dashboard receives data through the CircleCI Sumo Logic orb which must be included in your projects to be tracked.
133+
134+
### The Sumo Logic Orb
135+
136+
Find the latest version of the Sumo Logic orb on the [Orb Registry](https://circleci.com/orbs/registry/orb/circleci/sumologic).
137+
138+
#### 1. Import the Sumo Logic orb.
139+
Add the Sumo Logic orb to your project by including the top-level `orbs` key and import `circleci/[email protected]` as follows, replacing `x.y.z` with the latest version number at the link above.
140+
141+
```yaml
142+
orbs:
143+
sumologic: circleci/[email protected]
144+
```
145+
146+
#### 2. Add _Workflow-Collector_ to Workflow.
147+
The `workflow-collector` job runs concurrently along side your workflow and sends analytics to Sumo Logic until all of the jobs in your workflow have completed.
148+
149+
```yaml
150+
version: 2.1
151+
workflows:
152+
build-test-and-deploy:
153+
jobs:
154+
- sumologic/workflow-collector # add this job to track workflow.
155+
- build
156+
- test:
157+
requires:
158+
- build
159+
- deploy:
160+
requires:
161+
- test
162+
```
163+
#### 3. Create two source collectors.
164+
You will need to create two *source collectors* on Sumo Logic which will return an HTTPS URL. Your job data will be sent to this HTTPS URL.
165+
166+
You will need to create one called `circleci/job-collector` and another called `circleci/workflow-collector`.
167+
168+
To create the two source collectors:
169+
1. From the dashboard select the **Setup Wizard**.
170+
2. Select **Set Up Streaming Data**.
171+
3. Scroll to the bottom and select **All Other Sources**.
172+
4. Select **HTTPS Source**
173+
5. For the `Source Category` enter one of the two mentioned above.
174+
6. Save the resulting URL.
175+
176+
#### 4. Add environment variables.
177+
For each of the URLs produce in the previous step, create the corresponding environment variable.
178+
179+
Env vars:
180+
- `JOB_HTTP_SOURCE`
181+
- `WORKFLOW_HTTP_SOURCE`
182+
183+
**[How to add an environment variable to your project.]({{ site.baseurl }}/2.0/env-vars/#setting-an-environment-variable-in-a-project)**
184+
185+
This will link the orb with your Sumo Logic dashboard.
186+
187+
Your Sumo Logic dashboard will now begin to populate with data as each job runs on CircleCI.
188+
189+
## See Also
190+
Refer to the [Orbs Introduction]({{ site.baseurl }}/2.0/orb-intro/) document to learn more about using and authoring orbs.
191+
104192
### See Also
105193

106194
Refer to the [Collecting Test Metadata]({{ site.baseurl }}/2.0/collect-test-data/) document for instructions to configure insights into your most failed tests.

0 commit comments

Comments
 (0)