From 21f0e81664a9733cb0432c865fb43145a3e744b8 Mon Sep 17 00:00:00 2001 From: Bernd Ahlers Date: Tue, 12 Oct 2021 23:13:18 +0200 Subject: [PATCH] Update documentation links (#11457) Co-authored-by: Kyle Knight <122591+kyleknighted@users.noreply.github.com> --- docs/cef/README.md | 2 +- graylog-plugin-archetype/README.md | 2 +- .../archetype-resources/GETTING-STARTED.md | 2 +- .../PipelineProcessorMessageDecorator.java | 2 +- .../java/org/graylog2/plugin/DocsHelper.java | 15 ++-- graylog2-web-interface/src/util/DocsHelper.js | 72 +++++++++---------- misc/graylog.conf | 26 +++---- 7 files changed, 58 insertions(+), 63 deletions(-) diff --git a/docs/cef/README.md b/docs/cef/README.md index 21c78c0b48..fc002e125b 100644 --- a/docs/cef/README.md +++ b/docs/cef/README.md @@ -28,7 +28,7 @@ Some systems will send CEF as part of a RFC compliant syslog message. In this ca ### Parsing raw CEF or CEF embedded in any other envelopes -If the envelope is not syslog or the CEF message is not in an envelope at all, you can use the [Graylog Processing Pipelines](http://docs.graylog.org/en/latest/pages/pipelines.html) and the `parse_cef` function this plugin provides: +If the envelope is not syslog or the CEF message is not in an envelope at all, you can use the [Graylog Processing Pipelines](https://docs.graylog.org/docs/processing-pipelines) and the `parse_cef` function this plugin provides: 1. Use a pipeline rule to parse out the CEF part of the message (for example, using regex) and then apply the `parse_cef()` function on that extracted string. 1. If desired, use a second pipeline step to rename the `cef_` prefixed message fields to something easier to use and easier to remember. diff --git a/graylog-plugin-archetype/README.md b/graylog-plugin-archetype/README.md index a3729c43ce..122f89a192 100644 --- a/graylog-plugin-archetype/README.md +++ b/graylog-plugin-archetype/README.md @@ -1,7 +1,7 @@ Graylog Plugin Maven Archetype ============================== -See our latest documentation on [writing plugins](http://docs.graylog.org/en/latest/pages/plugins.html). +See our latest documentation on [writing plugins](https://docs.graylog.org/docs/plugins). ## Creating a new plugin project diff --git a/graylog-plugin-archetype/src/main/resources/archetype-resources/GETTING-STARTED.md b/graylog-plugin-archetype/src/main/resources/archetype-resources/GETTING-STARTED.md index dd82c9dbe1..10234dd9fb 100644 --- a/graylog-plugin-archetype/src/main/resources/archetype-resources/GETTING-STARTED.md +++ b/graylog-plugin-archetype/src/main/resources/archetype-resources/GETTING-STARTED.md @@ -3,7 +3,7 @@ Getting started with your new Graylog plugin Welcome to your new Graylog plugin! -Please refer to http://docs.graylog.org/en/latest/pages/plugins.html for documentation on how to write +Please refer to https://docs.graylog.org/docs/plugins for documentation on how to write plugins for Graylog. Travis CI diff --git a/graylog2-server/src/main/java/org/graylog/plugins/pipelineprocessor/PipelineProcessorMessageDecorator.java b/graylog2-server/src/main/java/org/graylog/plugins/pipelineprocessor/PipelineProcessorMessageDecorator.java index 176053da65..46837848db 100644 --- a/graylog2-server/src/main/java/org/graylog/plugins/pipelineprocessor/PipelineProcessorMessageDecorator.java +++ b/graylog2-server/src/main/java/org/graylog/plugins/pipelineprocessor/PipelineProcessorMessageDecorator.java @@ -86,7 +86,7 @@ public class PipelineProcessorMessageDecorator implements SearchResponseDecorato public static class Descriptor extends SearchResponseDecorator.Descriptor { public Descriptor() { - super("Pipeline Processor Decorator", "http://docs.graylog.org/en/2.0/pages/pipelines.html", "Pipeline Processor Decorator"); + super("Pipeline Processor Decorator", "https://docs.graylog.org/docs/processing-pipelines", "Pipeline Processor Decorator"); } } diff --git a/graylog2-server/src/main/java/org/graylog2/plugin/DocsHelper.java b/graylog2-server/src/main/java/org/graylog2/plugin/DocsHelper.java index 6d9ba7a774..941982c523 100644 --- a/graylog2-server/src/main/java/org/graylog2/plugin/DocsHelper.java +++ b/graylog2-server/src/main/java/org/graylog2/plugin/DocsHelper.java @@ -17,12 +17,12 @@ package org.graylog2.plugin; public enum DocsHelper { - PAGE_SENDING_JSONPATH("sending_data.html#json-path-from-http-api-input"), - PAGE_SENDING_IPFIXPATH("integrations/inputs/ipfix_input.html"), - PAGE_ES_CONFIGURATION("configuration/elasticsearch.html"), - PAGE_ES_VERSIONS("configuration/elasticsearch.html#elasticsearch-versions"); + PAGE_SENDING_JSONPATH("json"), + PAGE_SENDING_IPFIXPATH("ipfix-input"), + PAGE_ES_CONFIGURATION("elasticsearch"), + PAGE_ES_VERSIONS("elasticsearch#elasticsearch-versions"); - private static final String DOCS_URL = "http://docs.graylog.org/en/"; + private static final String DOCS_URL = "https://docs.graylog.org/docs/"; private final String path; @@ -32,10 +32,7 @@ public enum DocsHelper { @Override public String toString() { - final com.github.zafarkhaja.semver.Version version = Version.CURRENT_CLASSPATH.getVersion(); - final String shortVersion = version.getMajorVersion() + "." + version.getMinorVersion(); - - return DOCS_URL + shortVersion + "/pages/" + path; + return DOCS_URL + path; } public String toLink(String title) { diff --git a/graylog2-web-interface/src/util/DocsHelper.js b/graylog2-web-interface/src/util/DocsHelper.js index 144751ba05..329f78a9a1 100644 --- a/graylog2-web-interface/src/util/DocsHelper.js +++ b/graylog2-web-interface/src/util/DocsHelper.js @@ -14,52 +14,50 @@ * along with this program. If not, see * . */ -import Version from 'util/Version'; class DocsHelper { PAGES = { - ALERTS: 'streams/alerts.html', - AUTHENTICATORS: 'users_and_roles/external_auth.html', - CLUSTER_STATUS_EXPLAINED: 'configuration/elasticsearch.html#cluster-status-explained', - COLLECTOR: 'collector.html', - COLLECTOR_SIDECAR: 'sidecar.html', - COLLECTOR_STATUS: 'sidecar.html#sidecar-status', - CONFIGURING_ES: 'configuration/elasticsearch.html', - DASHBOARDS: 'dashboards.html', - DECORATORS: 'queries.html#decorators', - ENTERPRISE_SETUP: 'enterprise/setup.html', - ES_CLUSTER_STATUS_RED: 'configuration/elasticsearch.html#cluster-status-explained', - ES_CLUSTER_UNAVAILABLE: 'configuration/elasticsearch.html#configuration', - ES_OPEN_FILE_LIMITS: 'configuration/elasticsearch.html#open-file-limits', - EXTRACTORS: 'extractors.html', - INDEXER_FAILURES: 'indexer_failures.html', - INDEX_MODEL: 'configuration/index_model.html', - LOAD_BALANCERS: 'configuration/load_balancers.html', - LOOKUPTABLES: 'lookuptables.html', - PAGE_FLEXIBLE_DATE_CONVERTER: 'extractors.html#the-flexible-date-converter', - PAGE_STANDARD_DATE_CONVERTER: 'extractors.html#the-standard-date-converter', - PERMISSIONS: 'users_and_roles/permission_system.html', - PIPELINE_FUNCTIONS: 'pipelines/functions.html', - PIPELINE_RULES: 'pipelines/rules.html', - PIPELINES: 'pipelines.html', - REPORTING: 'reporting.html', - ROLLING_ES_UPGRADE: 'upgrade/rolling_es_upgrade.html', - SEARCH_QUERY_LANGUAGE: 'queries.html', - STREAMS: 'streams.html', - STREAM_PROCESSING_RUNTIME_LIMITS: 'streams.html#stream-processing-runtime-limits', - TIME_FRAME_SELECTOR: 'time_frame_selector.html', - UPGRADE_GUIDE: 'upgrade/graylog-%%version%%.html', - USERS_ROLES: 'users_and_roles.html', + ALERTS: 'alerts', + AUTHENTICATORS: 'permission-management#authentication', + CLUSTER_STATUS_EXPLAINED: 'elasticsearch#cluster-status-explained', + COLLECTOR: 'sidecar', + COLLECTOR_SIDECAR: 'sidecar', + COLLECTOR_STATUS: 'sidecar#sidecar-status', + CONFIGURING_ES: 'elasticsearch', + DASHBOARDS: 'dashboards', + DECORATORS: 'decorators', + ENTERPRISE_SETUP: 'setup', + ES_CLUSTER_STATUS_RED: 'elasticsearch#cluster-status-explained', + ES_CLUSTER_UNAVAILABLE: 'elasticsearch#configuration', + ES_OPEN_FILE_LIMITS: 'elasticsearch#configuration', + EXTRACTORS: 'extractors', + INDEXER_FAILURES: 'indexer-failures', + INDEX_MODEL: 'index-model', + LOAD_BALANCERS: 'load-balancers', + LOOKUPTABLES: 'lookuptables', + PAGE_FLEXIBLE_DATE_CONVERTER: 'extractors#normalization', + PAGE_STANDARD_DATE_CONVERTER: 'extractors#normalization', + PERMISSIONS: 'permission-management', + PIPELINE_FUNCTIONS: 'functions', + PIPELINE_RULES: 'rules', + PIPELINES: 'pipelines', + REPORTING: 'reporting', + ROLLING_ES_UPGRADE: 'rolling-es-upgrade', + SEARCH_QUERY_LANGUAGE: 'queries', + STREAMS: 'streams', + STREAM_PROCESSING_RUNTIME_LIMITS: 'streams#stream-processing-runtime-limits', + TIME_FRAME_SELECTOR: 'time-frame-selector', + UPGRADE_GUIDE: 'upgrading-graylog', + USERS_ROLES: 'permission-management', WELCOME: '', // Welcome page to the documentation }; - DOCS_URL = 'https://docs.graylog.org/en/'; + DOCS_URL = 'https://docs.graylog.org/docs'; toString(path) { - const version = Version.getMajorAndMinorVersion(); - const baseUrl = this.DOCS_URL + version; + const baseUrl = this.DOCS_URL; - return path === '' ? baseUrl : `${baseUrl}/pages/${path.replace('%%version%%', version)}`; + return path === '' ? baseUrl : `${baseUrl}/${path}`; } toLink(path, title) { diff --git a/misc/graylog.conf b/misc/graylog.conf index 1ad0df4c14..4a0a8e99f6 100644 --- a/misc/graylog.conf +++ b/misc/graylog.conf @@ -278,7 +278,7 @@ plugin_dir = plugin # to your previous 1.x settings so they will be migrated to the database! # This configuration setting is only used on the first start of Graylog. After that, # index related settings can be changed in the Graylog web interface on the 'System / Indices' page. -# Also see http://docs.graylog.org/en/2.3/pages/configuration/index_model.html#index-set-configuration. +# Also see https://docs.graylog.org/docs/index-model#index-set-configuration rotation_strategy = count # (Approximate) maximum number of documents in an Elasticsearch index before a new index @@ -289,7 +289,7 @@ rotation_strategy = count # to your previous 1.x settings so they will be migrated to the database! # This configuration setting is only used on the first start of Graylog. After that, # index related settings can be changed in the Graylog web interface on the 'System / Indices' page. -# Also see http://docs.graylog.org/en/2.3/pages/configuration/index_model.html#index-set-configuration. +# Also see https://docs.graylog.org/docs/index-model#index-set-configuration elasticsearch_max_docs_per_index = 20000000 # (Approximate) maximum size in bytes per Elasticsearch index on disk before a new index is being created, also see @@ -300,7 +300,7 @@ elasticsearch_max_docs_per_index = 20000000 # to your previous 1.x settings so they will be migrated to the database! # This configuration setting is only used on the first start of Graylog. After that, # index related settings can be changed in the Graylog web interface on the 'System / Indices' page. -# Also see http://docs.graylog.org/en/2.3/pages/configuration/index_model.html#index-set-configuration. +# Also see https://docs.graylog.org/docs/index-model#index-set-configuration #elasticsearch_max_size_per_index = 1073741824 # (Approximate) maximum time before a new Elasticsearch index is being created, also see @@ -318,7 +318,7 @@ elasticsearch_max_docs_per_index = 20000000 # to your previous 1.x settings so they will be migrated to the database! # This configuration setting is only used on the first start of Graylog. After that, # index related settings can be changed in the Graylog web interface on the 'System / Indices' page. -# Also see http://docs.graylog.org/en/2.3/pages/configuration/index_model.html#index-set-configuration. +# Also see https://docs.graylog.org/docs/index-model#index-set-configuration #elasticsearch_max_time_per_index = 1d # Disable checking the version of Elasticsearch for being compatible with this Graylog release. @@ -334,7 +334,7 @@ elasticsearch_max_docs_per_index = 20000000 # to your previous 1.x settings so they will be migrated to the database! # This configuration setting is only used on the first start of Graylog. After that, # index related settings can be changed in the Graylog web interface on the 'System / Indices' page. -# Also see http://docs.graylog.org/en/2.3/pages/configuration/index_model.html#index-set-configuration. +# Also see https://docs.graylog.org/docs/index-model#index-set-configuration elasticsearch_max_number_of_indices = 20 # Decide what happens with the oldest indices when the maximum number of indices is reached. @@ -346,7 +346,7 @@ elasticsearch_max_number_of_indices = 20 # to your previous 1.x settings so they will be migrated to the database! # This configuration setting is only used on the first start of Graylog. After that, # index related settings can be changed in the Graylog web interface on the 'System / Indices' page. -# Also see http://docs.graylog.org/en/2.3/pages/configuration/index_model.html#index-set-configuration. +# Also see https://docs.graylog.org/docs/index-model#index-set-configuration retention_strategy = delete # How many Elasticsearch shards and replicas should be used per index? Note that this only applies to newly created indices. @@ -354,7 +354,7 @@ retention_strategy = delete # to your previous settings so they will be migrated to the database! # This configuration setting is only used on the first start of Graylog. After that, # index related settings can be changed in the Graylog web interface on the 'System / Indices' page. -# Also see http://docs.graylog.org/en/2.3/pages/configuration/index_model.html#index-set-configuration. +# Also see https://docs.graylog.org/docs/index-model#index-set-configuration elasticsearch_shards = 4 elasticsearch_replicas = 0 @@ -364,7 +364,7 @@ elasticsearch_replicas = 0 # to your previous settings so they will be migrated to the database! # This configuration setting is only used on the first start of Graylog. After that, # index related settings can be changed in the Graylog web interface on the 'System / Indices' page. -# Also see http://docs.graylog.org/en/2.3/pages/configuration/index_model.html#index-set-configuration. +# Also see https://docs.graylog.org/docs/index-model#index-set-configuration elasticsearch_index_prefix = graylog # Name of the Elasticsearch index template used by Graylog to apply the mandatory index mapping. @@ -374,11 +374,11 @@ elasticsearch_index_prefix = graylog # to your previous settings so they will be migrated to the database! # This configuration setting is only used on the first start of Graylog. After that, # index related settings can be changed in the Graylog web interface on the 'System / Indices' page. -# Also see http://docs.graylog.org/en/2.3/pages/configuration/index_model.html#index-set-configuration. +# Also see https://docs.graylog.org/docs/index-model#index-set-configuration #elasticsearch_template_name = graylog-internal # Do you want to allow searches with leading wildcards? This can be extremely resource hungry and should only -# be enabled with care. See also: http://docs.graylog.org/en/2.1/pages/queries.html +# be enabled with care. See also: https://docs.graylog.org/docs/query-language allow_leading_wildcard_searches = false # Do you want to allow searches to be highlighted? Depending on the size of your messages this can be memory hungry and @@ -394,7 +394,7 @@ allow_highlighting = false # to your previous settings so they will be migrated to the database! # This configuration setting is only used on the first start of Graylog. After that, # index related settings can be changed in the Graylog web interface on the 'System / Indices' page. -# Also see http://docs.graylog.org/en/2.3/pages/configuration/index_model.html#index-set-configuration. +# Also see https://docs.graylog.org/docs/index-model#index-set-configuration elasticsearch_analyzer = standard # Global timeout for index optimization (force merge) requests. @@ -630,7 +630,7 @@ mongodb_threads_allowed_to_block_multiplier = 5 # to your previous settings so they will be migrated to the database! # This configuration setting is only used on the first start of Graylog. After that, # index related settings can be changed in the Graylog web interface on the 'System / Indices' page. -# Also see http://docs.graylog.org/en/2.3/pages/configuration/index_model.html#index-set-configuration. +# Also see https://docs.graylog.org/docs/index-model#index-set-configuration #disable_index_optimization = true # Optimize the index down to <= index_optimization_max_num_segments. A higher number may take some load from Elasticsearch @@ -640,7 +640,7 @@ mongodb_threads_allowed_to_block_multiplier = 5 # to your previous settings so they will be migrated to the database! # This configuration setting is only used on the first start of Graylog. After that, # index related settings can be changed in the Graylog web interface on the 'System / Indices' page. -# Also see http://docs.graylog.org/en/2.3/pages/configuration/index_model.html#index-set-configuration. +# Also see https://docs.graylog.org/docs/index-model#index-set-configuration #index_optimization_max_num_segments = 1 # The threshold of the garbage collection runs. If GC runs take longer than this threshold, a system notification