diff --git a/_data/navigation.yml b/_data/navigation.yml index 3f4e9fb8..55e95228 100644 --- a/_data/navigation.yml +++ b/_data/navigation.yml @@ -379,11 +379,6 @@ admin-guide-nav: url: /admin-guide/070_Destinations/081_http/002_Python_http_header_plugin - title: "The Azure auth header plugin" url: /admin-guide/070_Destinations/081_http/003_Azure_auth_header_plugin - - title: "http-java" - url: /admin-guide/070_Destinations/085_http-java/README - subnav: - - title: "HTTP Java destination options" - url: /admin-guide/070_Destinations/085_http-java/000_http_java_options - title: "kafka" url: /admin-guide/070_Destinations/100_Kafka-c/README subnav: diff --git a/doc/_admin-guide/030_Installing_syslog-ng/000_Compiling_syslog-ng_from_source.md b/doc/_admin-guide/030_Installing_syslog-ng/000_Compiling_syslog-ng_from_source.md index 5232771b..b74dd47d 100644 --- a/doc/_admin-guide/030_Installing_syslog-ng/000_Compiling_syslog-ng_from_source.md +++ b/doc/_admin-guide/030_Installing_syslog-ng/000_Compiling_syslog-ng_from_source.md @@ -33,8 +33,8 @@ and other platforms, see {{ site.product.name }} installation packages. - The {{ site.product.short_name }} application now uses PCRE-type regular expressions by default. It requires the libpcre library package. - - If you want to use the Java-based modules of {{ site.product.short_name }} (for - example, the Elasticsearch, HDFS, or Kafka destinations), you + - If you want to use a Java-based module of {{ site.product.short_name }} (for + example, the HDFS), you must compile {{ site.product.short_name }} with Java support. - Download and install the Java Runtime Environment (JRE), 1.7 @@ -59,8 +59,7 @@ and other platforms, see {{ site.product.name }} installation packages. 3. If you want to post log messages as HTTP requests using the http() destination, install the development files of the *libcurl* library. This library is not needed if you use the \--disable-http compile - option. Alternatively, you can use a Java-based implementation of - the HTTP destination. + option. 4. If you want to use the spoof-source function of {{ site.product.short_name }}, install the development files of the libnet library. diff --git a/doc/_admin-guide/030_Installing_syslog-ng/001_Compiling_options.md b/doc/_admin-guide/030_Installing_syslog-ng/001_Compiling_options.md index 378fb458..b635242b 100644 --- a/doc/_admin-guide/030_Installing_syslog-ng/001_Compiling_options.md +++ b/doc/_admin-guide/030_Installing_syslog-ng/001_Compiling_options.md @@ -54,7 +54,7 @@ compiling options. - *\--enable-ipv6* Enable IPv6 support. -- *\--enable-java* Enable support for Java-based modules. For other +- *\--enable-java* Enable support for the Java-based module. For other requirements, see the description of the Java-based module (for example, [[HDFS prerequisites|adm-dest-hdfs-pre]]) that you want to use. @@ -134,7 +134,7 @@ compiling options. - *\--with-libcurl* Specifies the path to the libcurl library. For details on using this destination, see - [[http: Posting messages over HTTP without Java]]. + [[http: Posting messages over HTTP]]. - *\--with-libhiredis* Specifies the path to the libhiredis library (0.11 or newer). For details on using this destination, see diff --git a/doc/_admin-guide/070_Destinations/070_HDFS/000_hdfs_prerequisites.md b/doc/_admin-guide/070_Destinations/070_HDFS/000_hdfs_prerequisites.md index de7ba0f3..989bd1f6 100644 --- a/doc/_admin-guide/070_Destinations/070_HDFS/000_hdfs_prerequisites.md +++ b/doc/_admin-guide/070_Destinations/070_HDFS/000_hdfs_prerequisites.md @@ -5,8 +5,8 @@ description: >- To send messages from {{ site.product.short_name }} to HDFS, complete the following steps. --- -1. If you want to use the Java-based modules of {{ site.product.short_name }} (for - example, the Elasticsearch, HDFS, or Kafka destinations), you must +1. If you want to use the Java-based module of {{ site.product.short_name }} (for + example, HDFS destination), you must compile {{ site.product.short_name }} with Java support. - Download and install the Java Runtime Environment (JRE), 1.7 (or diff --git a/doc/_admin-guide/070_Destinations/081_http/README.md b/doc/_admin-guide/070_Destinations/081_http/README.md index 3577e210..a02c907c 100644 --- a/doc/_admin-guide/070_Destinations/081_http/README.md +++ b/doc/_admin-guide/070_Destinations/081_http/README.md @@ -4,7 +4,7 @@ short_title: http id: adm-dest-http description: >- Version 3.8 of {{ site.product.short_name }} can directly post log messages to web - services using the HTTP protocol, without having to use Java. + services using the HTTP protocol. --- The current implementation has the following limitations: diff --git a/doc/_admin-guide/070_Destinations/085_http-java/000_http_java_options.md b/doc/_admin-guide/070_Destinations/085_http-java/000_http_java_options.md deleted file mode 100644 index a0e36fc3..00000000 --- a/doc/_admin-guide/070_Destinations/085_http-java/000_http_java_options.md +++ /dev/null @@ -1,74 +0,0 @@ ---- -title: HTTP Java destination options -id: adm-dest-http-java-opt -description: >- - This section describes the options of the Java-based http() destination in {{ site.product.short_name }}. ---- - -The http destination of {{ site.product.short_name }} can directly post log messages to -web services using the HTTP protocol. The http destination has the -following options. Some of these options are directly used by the Java -code underlying the http destination, therefore these options must be -specified in the following format: - -```config -option("", "") -``` - -For example, option("url", "http://\:\\"). -The exact format to use is indicated in the description of the option. - -## Required options - -The following options are required: url(). - -{% include doc/admin-guide/options/ca-dir.md %} - -{% include doc/admin-guide/options/ca-file.md %} - -## class-name() - -| Type:| string| -| Default:| N/A| - -*Description:* The name of the class (including the name of the package) -that includes the destination driver to use. - -For the http destination, use this option as -**class-name(\"org.syslog\_ng.http.HTTPDestination\")**. - -{% include doc/admin-guide/options/client-lib-dir.md %} - -{% include doc/admin-guide/options/hook.md %} - -{% include doc/admin-guide/options/jvm-options.md %} - -{% include doc/admin-guide/options/log-fifo-size.md %} - -## method() - -| Type: | DELETE \| HEAD \| GET \| OPTIONS \| POST \| PUT \| TRACE | -|Default: | PUT| - -*Description:* Specifies the HTTP method to use when sending the message -to the server. Available in {{ site.product.short_name }} version 3.7.2 and newer. - -{% include doc/admin-guide/options/retries.md %} - -{% include doc/admin-guide/options/template-logformat.md %} - -{% include doc/admin-guide/options/throttle.md %} - -{% include doc/admin-guide/options/timeout.md %} - -## url() - -|Type: | URL| -|Default:|| - -*Description:* Specifies the hostname or IP address and optionally the -port number of the web service that can receive log data via HTTP. Use a -colon (**:**) after the address to specify the port number of the -server. You can also use macros, templates, and template functions in -the URL, for example: -http://host.example.com:8080/${MACRO1}/${MACRO2}/script\") diff --git a/doc/_admin-guide/070_Destinations/085_http-java/README.md b/doc/_admin-guide/070_Destinations/085_http-java/README.md deleted file mode 100644 index 285a1b19..00000000 --- a/doc/_admin-guide/070_Destinations/085_http-java/README.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -title: Posting messages over HTTP using Java -short_title: http-java -id: adm-dest-http-java -description: >- - Version 3.7 of {{ site.product.short_name }} can directly post log messages to web - services using the HTTP protocol. Error and status messages received - from the HTTP server are forwarded to the internal logs of syslog-ng - OSE. ---- - -The current implementation has the following limitations: - -- This destination is only supported on the Linux platform. - -- Only HTTP connections are supported, HTTPS is not. - -- This destination requires Java. For an http destination that does - not use Java, see http: Posting messages over HTTP without - Java. - -**Declaration** - -```config -java( - class-path("/syslog-ng/install_dir/lib/syslog-ng/java-modules/*.jar") - class-name("org.syslog_ng.http.HTTPDestination") - - option("url", "http://:") - -); -``` - -### Example: Sending log data to a web service - -The following example defines an http destination. - -```config -destination d_http { - java( - class-path("/syslog-ng/install_dir/lib/syslog-ng/java-modules/*.jar") - class-name("org.syslog_ng.http.HTTPDestination") - - option("url", "http://192.168.1.1:80") - ); -}; - -log - { source(s_file); destination(d_http); flags(flow-control); }; -``` - -**NOTE:** If you delete all Java destinations from your configuration and -reload {{ site.product.short_name }}, the JVM is not used anymore, but it is still running. -If you want to stop JVM, stop {{ site.product.short_name }} and then start {{ site.product.short_name }} again. -{: .notice--info} diff --git a/doc/_admin-guide/070_Destinations/100_Kafka-c/000_Before_you_begin.md b/doc/_admin-guide/070_Destinations/100_Kafka-c/000_Before_you_begin.md index 08813fe2..105d2eb8 100644 --- a/doc/_admin-guide/070_Destinations/100_Kafka-c/000_Before_you_begin.md +++ b/doc/_admin-guide/070_Destinations/100_Kafka-c/000_Before_you_begin.md @@ -30,8 +30,6 @@ description: >- **Declaration** ```config -@define kafka-implementation kafka-c - kafka( bootstrap-servers("1.2.3.4:9092,192.168.0.2:9092") topic("{MYTOPIC}") diff --git a/doc/_admin-guide/070_Destinations/100_Kafka-c/001_Shifting_from_Java_to_C.md b/doc/_admin-guide/070_Destinations/100_Kafka-c/001_Shifting_from_Java_to_C.md index 772ec7fe..fc02f0e9 100644 --- a/doc/_admin-guide/070_Destinations/100_Kafka-c/001_Shifting_from_Java_to_C.md +++ b/doc/_admin-guide/070_Destinations/100_Kafka-c/001_Shifting_from_Java_to_C.md @@ -15,9 +15,7 @@ description: >- - The kafka-bootstrap-servers() option has been renamed bootstrap-servers(). -- The properties-file() is a Java properties file with options that - are similar to, but not identical with, the options in the old, Java - implementation's properties-file(). For more information, click here. TODO +- The properties-file() was replaced with the config() option of kafka-c, which is similiar but not identical to the properties-file() option. - The sync-send() option has been deprecated. Remove it from the configuration file. diff --git a/doc/_admin-guide/070_Destinations/100_Kafka-c/003_Kafka-c_options.md b/doc/_admin-guide/070_Destinations/100_Kafka-c/003_Kafka-c_options.md index 4ccf901d..7b7a2f50 100644 --- a/doc/_admin-guide/070_Destinations/100_Kafka-c/003_Kafka-c_options.md +++ b/doc/_admin-guide/070_Destinations/100_Kafka-c/003_Kafka-c_options.md @@ -10,14 +10,7 @@ directly publish log messages to the Apache Kafka message bus, where subscribers ## Required options -The following options are required: bootstrap-servers(), topic(). Note -that to use the C implementation of the kafka() destination, you must -add the following lines to the beginning of your {{ site.product.short_name }} -configuration: - -```config -@define kafka-implementation kafka-c -``` +The following options are required: bootstrap-servers(), topic(). {% include doc/admin-guide/notes/kafka-c.md %} @@ -80,8 +73,7 @@ The programming language accepts this option for better compatibility. | Type:| | |Default:| | -*Description:* You can use this option to expand or override the options -of the properties-file(). +*Description:* You can use this option to set the properties of the kafka producer. {% include doc/admin-guide/notes/kafka-c.md %} @@ -154,31 +146,6 @@ client about the amount of messages sent since the last poll-timeout (). In case of multithreading, the first {{ site.product.short_name }} worker is responsible for poll-timeout(). -## properties-file() - -| Type:| string (absolute path)| - |Default:| N/A| - -*Description:* The absolute path and filename of the Kafka properties -file to load. For example, -properties-file(\"/opt/syslog-ng/etc/kafka_dest.properties\"). The -{{ site.product.short_name }} application reads this file and passes the properties to -the Kafka Producer. - -The {{ site.product.short_name }} kafka destination supports all properties of the -official Kafka producer. For details, see the librdkafka documentation. - -The bootstrap-servers option is translated to the bootstrap.servers -property. - -For example, the following properties file defines the acknowledgment -method and compression: - -```config -acks=all -compression.type=snappy. -``` - {% include doc/admin-guide/notes/kafka-c.md %} {% include doc/admin-guide/options/retries.md %} diff --git a/doc/_admin-guide/190_The_syslog-ng_manual_pages/007_syslog-ng_control_tool.md b/doc/_admin-guide/190_The_syslog-ng_manual_pages/007_syslog-ng_control_tool.md index 5e499e08..97ce9193 100644 --- a/doc/_admin-guide/190_The_syslog-ng_manual_pages/007_syslog-ng_control_tool.md +++ b/doc/_admin-guide/190_The_syslog-ng_manual_pages/007_syslog-ng_control_tool.md @@ -109,9 +109,6 @@ An example output: >center.received.stats.processed >center.queued.stats.processed ->destination.java.d_elastic#0.java_dst(ElasticSearch,elasticsearch-syslog-ng-test,t7cde889529c034aea9ec_micek).stats.>dropped ->destination.java.d_elastic#0.java_dst(ElasticSearch,elasticsearch-syslog-ng-test,t7cde889529c034aea9ec_micek).stats.>processed ->destination.java.d_elastic#0.java_dst(ElasticSearch,elasticsearch-syslog-ng-test,t7cde889529c034aea9ec_micek).stats.>queued >destination.d_elastic.stats.processed >source.s_tcp.stats.processed >source.severity.7.stats.processed @@ -169,9 +166,6 @@ the query, and their values. For example, the destination query lists the configured destinations, and the metrics related to each destination. An example output: ->destination.java.d_elastic#0.java_dst(ElasticSearch,elasticsearch-syslog-ng-test,t7cde889529c034aea9ec_micek).stats.dropped=0 ->destination.java.d_elastic#0.java_dst(ElasticSearch,elasticsearch-syslog-ng-test,t7cde889529c034aea9ec_micek).stats.processed=0 ->destination.java.d_elastic#0.java_dst(ElasticSearch,elasticsearch-syslog-ng-test,t7cde889529c034aea9ec_micek).stats.queued=0 >destination.d_elastic.stats.processed=0 The syslog-ng-ctl query get command has the following options: diff --git a/doc/_admin-guide/190_The_syslog-ng_manual_pages/010_syslog-ng_conf.md b/doc/_admin-guide/190_The_syslog-ng_manual_pages/010_syslog-ng_conf.md index b1bdbe57..2f6a3851 100644 --- a/doc/_admin-guide/190_The_syslog-ng_manual_pages/010_syslog-ng_conf.md +++ b/doc/_admin-guide/190_The_syslog-ng_manual_pages/010_syslog-ng_conf.md @@ -245,7 +245,7 @@ listed below. |Name |Description |---|--- |amqp()| Publishes messages using the AMQP (Advanced Message Queuing Protocol). -|elasticsearch2| Sends messages to an Elasticsearch server. The elasticsearch2 driver supports Elasticsearch version 2 and newer. +|elasticsearch-http| Sends messages to an Elasticsearch server. |file()| Writes messages to the specified file. |graphite()| Sends metrics to a Graphite server to store numeric time-series data. |graylog2()| Sends syslog messages to Graylog.