packetbeat
Version information
This version is compatible with:
- Puppet Enterprise 2017.2.x, 2017.1.x, 2016.5.x, 2016.4.x
- Puppet >=4.0.0 <5.0.0
- , , , , , , , ,
Start using this module
Add this module to your Puppetfile:
mod 'coreyh-packetbeat', '0.1.0'
Learn more about managing modules with a PuppetfileDocumentation
packetbeat
Table of Contents
- Description
- Setup - The basics of getting started with packetbeat
- Usage - Configuration options and additional functionality
- Reference - An under-the-hood peek at what the module is doing and how
- Limitations - OS compatibility, etc.
- Development - Guide for contributing to the module
Description
The packetbeat
module installs the packetbeat network packet analyzer maintained by elastic.
Setup
What packetbeat affects
By default packetbeat
adds a software repository to your system and installs packetbeat
along with the required configurations.
Setup Requirements OPTIONAL
The packetbeat
module depends on puppetlabs-stdlib
and
puppetlabs/apt
on Debian base systems.
Beginning with packetbeat
packetbeat
requires the protocols
and outputs
parameters to be declared, without which
the service does nothing.
Usage
As of this writing all the default values follow the upstream values. This module saves all configuration
options in a to_yaml()
fashion, therefore multiple instances of the same protocol are not possible.
To ship HTTP traffic to elasticsearch
class{'packetbeat':
protocols => {
'http' => {
'ports' => [80]
}
},
outputs => {
'elasticsearch' => {
'hosts' => ['localhost:9200']
}
}
}
To ship MySQL traffic through logstash
class{'packetbeat':
protocols => {
'mysql' => {
'ports' => [3306]
}
},
outputs => {
'logstash' => {
'hosts' => ['localhost:5044'],
'index' => 'packetbeat'
}
}
}
Network device configuation and logging can be configured the same way. Please review the documentation of the elastic website
Processors
Libbeat 5.0 and later include a feature for filtering/enhancing exported data
called processors.
These may be added into the configuration by populating the processors
parameter
and may apply to all events or those that match certain conditions.
To drop events that have an http response code between 200 and 299
class{'packetbeat':
processors => [
{
'drop_event' => {
'when' => {
'http.response.code.gte' => 200,
'http.response.code.lt' => 300
}
}
}
],
...
}
To drop the mysql.num_fields
field from the output
class{'packetbeat':
processors => [
{
'drop_field' => {
'fields' => 'mysql.num_fields'
}
}
]
}
For more information please review the documentation
Reference
Public Classes
Class: packetbeat
Installs and configures packetbeat.
Parameters within packetbeat
outputs
: [Hash] The required outputs section of the configuration.protocols
: [Hash] The required protocols section of the configuration.ensure
: [String] Valid values are 'present' and 'absent'. Determines weather to manage all required resources or remove them from the node. (default: 'present')beat_name
: [String] The name of the beat shipper (default: hostname)bpf_filter
: [String] Overwrite packetbeat's automatically generatedBPF
with this value. This setting is only available iftype
is configured for 'af_packet'. NOTE: It is the responsibility of the user to ensure this is in-sync with the protocols.buffer_size_mb
: [Integer] The maximum size of the shared memory buffer to use between the kernel and user-space. This setting is only available iftype
is configured for 'af_packet'.config_file_mode
: [String] The octal permissions to set on configuration files. (default: '0644')device
: [String] The name of the interface from which to capture traffic. (default: 'any')fields
: [Hash] Optional fields to add any additional information to the output. (default: undef)fields_under_root
: [Boolean] By default custom fields are under afields
sub-dictionary. When set to true custom fields are added to the root-level document. (default: false)flow_enable
: [Boolean] Enables or disables the bidirectional network flows. (default: true)flow_period
: [String] Configures the reporting interval where all network flows are reported at the same time. This option takes a number followed by a time unit suffix, 's' representing seconds, 'm' representing minutes and so on. (default: '10s')flow_timeout
: [String] Configures the lifetime of the flow. Likeflow_period
this option takes a number followed by a time-unit suffix. (default: '30s')logging
: [Hash] Defines packetbeat's logging configuration, if not explicitly configured all logging output is forwarded to syslog on Linux nodes and file output on Windows. See the docs for all available options.manage_repo
: [Boolean] When false does not install the upstream repository to the node's package manager. (default: true)package_ensure
: [String] The desired state of the Package resources. Only applicable ifensure
is 'present'. (default: 'present')path_conf
: [Stdlib::Absolutepath] The base path for all packetbeat configurations. (default: /etc/packetbeat)path_data
: [Stdlib::Absolutepath] The base path to where packetbeat stores its data. (default: /var/lib/packetbeat)path_home
: [Stdlib::Absolutepath] The base path for the packetbeat installation, where the packetbeat binary is stored. (default: /usr/share/packetbeat)path_logs
: [Stdlib::Absolutepath] The base path for packetbeat's log files. (default: /var/log/packetbeat)processors
: [Array[Hash]] Add processors to the configuration to run on data before sending to the output. (default: undef)queue_size
: [Integer] The queue size for single events in the processing pipeline. (default: 1000)service_ensure
: [String] Determine the state of the packet beat service. Must be one of 'enabled', 'disabled', 'running', 'unmanaged'. (default: enabled)service_has_restart
: [Boolean] When true the Service resource issues the 'restart' command instead of 'stop' and 'start'. (default: true)snaplen
: [Integer] The maximum size of the packets to capture. Most environments can accept the default, on a physical interface the optimal value is the MTU size. (default: 65535)sniff_type
: [String] Configure the sniffer type, packet beat only supports 'pcap', 'af_packet' (Linux only, faster than 'pcap') and 'pf_ring' (Requires a kernel module and a re-compilation of Packetbeat, not supported by Elastic). (default: 'pcap')tags
: [Array] Optional list of tags to help group different logical properties easily. (default: undef)with_vlans
: [Boolean] If traffic contains VLAN tags all traffic is offset by four bits and packetbeat's internal BPF filter is ineffective. Only used ifsniff_type
is 'af_packet'. (default: undef)
Private Classes
Class: packetbeat::config
Manages packetbeats main configuration file under path_conf
Class: packetbeat::config
Installs the packetbeat package.
Class: packetbeat::repo
Installs the upstream Yum or Apt repository for the system package manager.
Class: packetbeat::service
Manages the packetbeat service.
Limitations
This module does not support loading kibana dashboards or elasticsearch templates, used when outputting to Elasticsearch.
Major Versions
This module was written for packetbeat versions 5.0 and greater. There is no supported for 1.x versions.
Development
Pull requests and bug reports are welcome. If you're sending a pull request, please consider writing tests if applicable.
Testing
In the root of your checkout directory execute the following commands to setup and perform automatic testing of new code submissions.
- Installs all Ruby Gems
bundle install
- Perform tests
bundle exec rake validate test rubocop
Changelog
0.1.0
- Initial release, review module examples and packetbeat documentation for configuration options
Dependencies
- puppetlabs-stdlib (>= 4.13.0 < 5.0.0)
- puppetlabs-apt (>= 2.0.0 < 3.0.0)
Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "{}" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright {yyyy} {name of copyright owner} Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.