rsyslog-doc icon indicating copy to clipboard operation
rsyslog-doc copied to clipboard

Update module doc titles to use consistent names

Open deoren opened this issue 6 years ago • 0 comments

This is important from a standardization standpoint, but also for linkage.

As we update the reST files the old hard-coded HTML links and some explicit link labels are being updated to use bare :doc: references. Those references result in the doc page titles being used as the link text. By having a consistent naming pattern we will have a solid idea of what wording to use when creating referring to other doc pages.

Output Modules listing (80d1241)

Just a small number mismatched here

  • omamqp1: AMQP 1.0 Messaging Output Module
  • omelasticsearch: Elasticsearch Output Module
  • omfile: File Output Module
  • omfwd: syslog Forwarding Output Module
  • omhdfs: Hadoop Filesystem Output Module
  • omhiredis: Redis Output Module
  • omhttpfs: Hadoop HTTPFS Output Module
  • omjournal: Systemd Journal Output
  • omkafka: write to Apache Kafka
  • omlibdbi: Generic Database Output Module
  • ommail: Mail Output Module
  • ommongodb: MongoDB Output Module
  • ommysql: MySQL Database Output Module
  • omoracle: Oracle Database Output Module
  • PostgreSQL Database Output Module (ompgsql)
  • ompipe: Pipe Output Module
  • omprog: Program integration Output module
  • omrelp: RELP Output Module
  • omruleset: ruleset output/including module
  • omsnmp: SNMP Trap Output Module
  • omstdout: stdout output module (testbench tool)
  • omudpspoof: UDP spoofing output module
  • omusrmsg: notify users
  • omuxsock: Unix sockets Output Module
  • GuardTime Log Signature Provider (gt)
  • Keyless Signature Infrastructure Provider (ksi)
  • Keyless Signature Infrastructure Provider (rsyslog-ksi-ls12)

Message Modification Modules listing (80d1241)

This modules list is almost entirely in the other direction.

  • IP Address Anonymization Module (mmanon)
  • mmcount
  • MaxMind/GeoIP DB lookup (mmdblookup)
  • Support module for external message modification modules
  • Fields Extraction Module (mmfields)
  • JSON/CEE Structured Content Extraction Module (mmjsonparse)
  • Log Message Normalization Module (mmnormalize)
  • RFC5424 structured data parsing module (mmpstrucdata)
  • mmrfc5424addhmac
  • mmrm1stspace: First Space Modification Module
  • Number generator and counter module (mmsequence)
  • mmsnmptrapd message modification module
  • Fix invalid UTF-8 Sequences (mmutf8fix)

deoren avatar Mar 11 '18 16:03 deoren