theforeman / foreman_supervisory_authority

This Foreman plug-in integrates with Elastic APM.

ForemanSupervisoryAuthority

This Foreman plug-in adds support for reporting data to the Elastic APM.

Compatibility

Foreman Version	Plugin Version
>= 1.20	~> 0.0.2
>= 3.0	~> 0.1.0

Installation

See How_to_Install_a_Plugin for how to install Foreman plugins.

Configuration

This plugin needs to be configured via a config file. On a production environment the config file needs to be located at /etc/foreman/plugins/foreman_supervisory_authority.yaml. On a development environment, the file is expected to be at config/settings.plugins.d/foreman_supervisory_authority.yaml. Below you can find an example config file. All the possible parameters are documented on the Elastic site.

:foreman_supervisory_authority:
  server_url: https://elastic-apm.example.com
  secret_token: "12345verysecret"
  service_name: "foreman"
  transaction_max_spans: 100

Contributing

Fork and send a Pull Request. Thanks!

Copyright

Copyright (c) 2019 Timo Goebel

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.

foreman_supervisory_authority's Issues

needs upgrade to ruby 2.5.4 on RHEL

Due to a ruby bug introduced in 2.5 a segmentation fault can happen when accessing  Queue.push. This is suspected to be a fix for crashes of the APM agent. The fix is included in ruby 2.5.4+. The current version shipped within the SCL is 2.5.3 (this version does not include the fix).

Issue to upgrade the ruby version in the SCL: https://bugzilla.redhat.com/show_bug.cgi?id=1688754
Elastic APM issue with more details: elastic/apm-agent-ruby#383

filter the Set-Cookie header

The Set-Cookie header may contain the session id. This should be filtered.

make the net-http spy usable

We currently disable the net-http spy:
https://github.com/timogoebel/foreman_supervisory_authority/blob/95c7dcd7b041597b3351ed437c79e8d80fbf5745/lib/foreman_supervisory_authority/engine.rb#L17-L20

This is because Foreman extends net/http using Module.prepend:

https://github.com/theforeman/foreman/blob/84ae69c6bf191837e8c7b4ccadb4583eebeda172/lib/foreman/http_proxy/net_http_extension.rb#L20-L23

And the elastic APM uses alias_method, which conflicts.

Elastic-APM Issue: elastic/apm-agent-ruby#379