Skip to content

Commit c83a230

Browse files
jamescottjamescott
jamescott
authored and
jamescott
committed
edit intro
1 parent ffde98f commit c83a230

File tree

3 files changed

+16
-54
lines changed

3 files changed

+16
-54
lines changed

‎chef_master/source/analytics.rst

+14-46
Original file line numberDiff line numberDiff line change
@@ -4,55 +4,23 @@
44

55
.. include:: ../../includes_analytics/includes_analytics.rst
66

7-
|chef actions_title|
8-
=====================================================
9-
10-
.. include:: ../../includes_actions/includes_actions.rst
11-
12-
.. include:: ../../includes_actions/includes_actions_long.rst
13-
14-
Install |chef actions| by installing the `Analytics <http://docs.chef.io/install_analytics.html>`_ premium feature of the |chef server|.
15-
16-
Architecture
17-
-----------------------------------------------------
18-
.. include:: ../../includes_actions/includes_actions_architecture.rst
197

20-
Data Tracking
21-
+++++++++++++++++++++++++++++++++++++++++++++++++++++
22-
.. include:: ../../includes_actions/includes_actions_tracked_data.rst
23-
24-
User Interface
8+
|chef analytics_title| Components
259
=====================================================
26-
.. include:: ../../includes_analytics/includes_analytics_ui.rst
27-
28-
Enable Auto-Refresh
29-
-----------------------------------------------------
30-
.. include:: ../../step_actions_webui/step_actions_webui_enable_auto_refresh_mode.rst
31-
32-
Export Actions
33-
-----------------------------------------------------
34-
.. include:: ../../step_actions_webui/step_actions_webui_export_action_list.rst
35-
36-
Load More Actions
37-
-----------------------------------------------------
38-
.. include:: ../../step_actions_webui/step_actions_webui_load_more_actions.rst
39-
40-
Log In
41-
-----------------------------------------------------
42-
.. include:: ../../step_actions_webui/step_actions_webui_log_in.rst
10+
The following diagram shows the relationships between the various elements of |chef analytics|, including how information is routed from various nodes to the |chef analytics| server (through the |chef server|) nodes, where reports about |chef client| run outcomes may be viewed, where rules are processed, and where analytics data may be viewed. As you are reviewing the rest of this topic, use the icons in the tables to refer back to this image.
4311

44-
Save Search Query
45-
-----------------------------------------------------
46-
.. include:: ../../step_actions_webui/step_actions_webui_save_search_query.rst
12+
.. image:: ../../images/chef_analytics.png
4713

48-
Search Actions
49-
-----------------------------------------------------
50-
.. include:: ../../step_actions_webui/step_actions_webui_search.rst
14+
.. list-table::
15+
:widths: 60 420
16+
:header-rows: 1
5117

52-
Switch Orgs
53-
-----------------------------------------------------
54-
.. include:: ../../step_actions_webui/step_actions_webui_switch_orgs.rst
18+
* - Feature
19+
- Description
20+
* - |chef actions_title|
21+
- .. include:: ../../includes_actions/includes_actions.rst
22+
* - |reporting_title|
23+
- .. include:: ../../includes_reporting/includes_reporting.rst
24+
* - |rules_analytics_title|
25+
- .. include:: ../../includes_analytics_rules/includes_analytics_rules.rst
5526

56-
View Action Details
57-
-----------------------------------------------------
58-
.. include:: ../../step_actions_webui/step_actions_webui_view_action_details.rst

‎includes_analytics/includes_analytics.rst

+1-7
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,4 @@
22
.. This file should not be changed in a way that hinders its ability to appear in multiple documentation sets.
33
44
5-
The |chef analytics| platform is a feature of |chef| that provides real-time visibility into what is happening on the |chef server|, including what's changing, who made those changes, and when they occurred. Individuals may be notified of these changes in real-time. Use this visibility to verify compliance against internal controls.
6-
7-
|chef analytics| runs on separate hardware from the |chef server| and consists of the following components:
8-
9-
* |chef actions|. Actions are policy and administrative changes made to the |chef server|. The |chef server| gathers a lot of data—--each node object, the node run history for all nodes, the history of every cookbook and cookbook version, how policy settings, such as roles, environments, and data bags, are applied and to what they are applied, individual user data, and so on.
10-
11-
5+
The |chef analytics| platform is a feature of |chef| that provides real-time visibility into what is happening on the |chef server|, including what's changing, who made those changes, and when they occurred. Individuals may be notified of these changes in real-time. Use this visibility to verify compliance against internal controls.

‎includes_analytics_rules/includes_analytics_rules.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,4 @@
22
.. This file should not be changed in a way that hinders its ability to appear in multiple documentation sets.
33
44
5-
|chef analytics| rules enable the tracking of detailed events that occur during a |chef client| run and of events that describe the expected state of the system.
5+
|chef analytics| rules are used to track events that are generated by the outcome of tests that are run as part of the |chef client| run. These tests are configured in cookbooks using the ``control`` and ``control_group`` |dsl recipe| methods. Rules are written to track specific outcomes of these tests, and to then send notifications about these outcomes to various endpoints, such as email, company chat services, and so on.

0 commit comments

Comments
 (0)