elastic / logstash

Logstash - transport and process your logs, events, or other data
https://www.elastic.co/products/logstash
Other
67 stars 3.5k forks source link

Remove broken plugins from documentation #8266

Open jordansissel opened 7 years ago

jordansissel commented 7 years ago

I generated a plugins status with rake generate_plugins_versions on the master branch.

There are many plugins which will not install at all in Logstash. Generated this list with the following:

% rake generate_plugins_versions
<wait a few minutes for this to finish>
% cat plugins_version_docs.json | jq '.failures  | to_entries[] | .key' | fex '"1' | sed -e 's@^.*$@* [&](https://github.com/logstash-plugins/&)@'

MASTER

Plugins which fail to install in master

5.6 failures

% cat plugins_version_docs.json | jq '.failures | to_entries[] | .key' | fex '"1' | sed -e 's@^.$@ &@' | sort

You can rerun rake generate_plugins_versions on any other branch( 5.6, etc) to determine which plugins are failing.

Rough proposal:

1) Fix any broken plugins we desire 2) Remove any still-broken plugins from the logstash docs for any affected branches.

jordansissel commented 7 years ago

MASTER

Reasons plugins have failed to install in master:

% cat plugins_version_docs.json | jq '.failures  | to_entries[] | "* \(.key) fails due to \(.value.klass): \(.value.message[47:90])"' | sed -e 's/^"//;s/"$//'
jordansissel commented 7 years ago

The following plugins are marked skip in v5.6.0:

% cat rakelib/plugins-metadata.json| jq 'to_entries[] | select(.value["skip-list"]) | .key' "logstash-input-jdbc" "logstash-output-webhdfs" "logstash-filter-yaml" "logstash-input-example" "logstash-codec-example" "logstash-filter-example" "logstash-output-example" "logstash-input-drupal_dblog" "logstash-output-logentries" "logstash-output-newrelic" "logstash-output-slack" "logstash-input-neo4j" "logstash-output-neo4j" "logstash-input-perfmon" "logstash-input-rackspace" "logstash-output-rackspace" "logstash-input-dynamodb" "logstash-filter-language" "logstash-input-heroku" "logstash-output-google_cloud_storage" "logstash-input-journald" "logstash-input-log4j2" "logstash-codec-cloudtrail"

josephlewis42 commented 6 years ago

Hey @jordansissel, any idea why a plugin might be marked as skip?

I noticed the published docs for logstash-output-google_cloud_storage are pretty out of date and I'd like to get them out again. Maybe it's a quality issue more related to #6693?

jordansissel commented 6 years ago

It was added to the skip list in 97352c7960 (April 2016) with a commit message indicating that it failed to build (https://github.com/elastic/logstash/pull/5054). This was back when we were producing an artifact called "all plugins" which would contain all plugins, and we were rejecting plugins for this all-plugins artifact which had problems (test failures, dependency problems, etc). We no longer produce an all-plugins artifact, though.

@josephlewis42 It's possible that it's safe to remove this plugin from the skip list. Can you open a separate issue for this?