mirror of
https://github.com/zeek/zeek.git
synced 2025-10-02 22:58:20 +00:00
Remove broxygen Sphinx integration
The broxygen-generated files now live in the git repo, have tests that check that they are up-to-date, and a script to re-generate them on-demand.
This commit is contained in:
parent
9e5e9d04b7
commit
7e9d48f532
549 changed files with 89909 additions and 100 deletions
14
doc/scripts/base/protocols/mysql/__load__.bro.rst
Normal file
14
doc/scripts/base/protocols/mysql/__load__.bro.rst
Normal file
|
@ -0,0 +1,14 @@
|
|||
:tocdepth: 3
|
||||
|
||||
base/protocols/mysql/__load__.bro
|
||||
=================================
|
||||
|
||||
|
||||
:Imports: :doc:`base/protocols/mysql/main.bro </scripts/base/protocols/mysql/main.bro>`
|
||||
|
||||
Summary
|
||||
~~~~~~~
|
||||
|
||||
Detailed Interface
|
||||
~~~~~~~~~~~~~~~~~~
|
||||
|
67
doc/scripts/base/protocols/mysql/consts.bro.rst
Normal file
67
doc/scripts/base/protocols/mysql/consts.bro.rst
Normal file
|
@ -0,0 +1,67 @@
|
|||
:tocdepth: 3
|
||||
|
||||
base/protocols/mysql/consts.bro
|
||||
===============================
|
||||
.. bro:namespace:: MySQL
|
||||
|
||||
|
||||
:Namespace: MySQL
|
||||
|
||||
Summary
|
||||
~~~~~~~
|
||||
Constants
|
||||
#########
|
||||
============================================================================================================== =
|
||||
:bro:id:`MySQL::commands`: :bro:type:`table` :bro:attr:`&default` = :bro:type:`function` :bro:attr:`&optional`
|
||||
============================================================================================================== =
|
||||
|
||||
|
||||
Detailed Interface
|
||||
~~~~~~~~~~~~~~~~~~
|
||||
Constants
|
||||
#########
|
||||
.. bro:id:: MySQL::commands
|
||||
|
||||
:Type: :bro:type:`table` [:bro:type:`count`] of :bro:type:`string`
|
||||
:Attributes: :bro:attr:`&default` = :bro:type:`function` :bro:attr:`&optional`
|
||||
:Default:
|
||||
|
||||
::
|
||||
|
||||
{
|
||||
[2] = "init_db",
|
||||
[9] = "statistics",
|
||||
[17] = "change_user",
|
||||
[27] = "set_option",
|
||||
[6] = "drop_db",
|
||||
[11] = "connect",
|
||||
[14] = "ping",
|
||||
[4] = "field_list",
|
||||
[22] = "stmt_prepare",
|
||||
[24] = "stmt_send_long_data",
|
||||
[30] = "binlog_dump_gtid",
|
||||
[1] = "quit",
|
||||
[8] = "shutdown",
|
||||
[7] = "refresh",
|
||||
[15] = "time",
|
||||
[23] = "stmt_execute",
|
||||
[29] = "daemon",
|
||||
[5] = "create_db",
|
||||
[25] = "stmt_close",
|
||||
[19] = "table_dump",
|
||||
[28] = "stmt_fetch",
|
||||
[31] = "reset_connection",
|
||||
[10] = "process_info",
|
||||
[0] = "sleep",
|
||||
[3] = "query",
|
||||
[12] = "process_kill",
|
||||
[13] = "debug",
|
||||
[18] = "binlog_dump",
|
||||
[21] = "register_slave",
|
||||
[16] = "delayed_insert",
|
||||
[20] = "connect_out",
|
||||
[26] = "stmt_reset"
|
||||
}
|
||||
|
||||
|
||||
|
17
doc/scripts/base/protocols/mysql/index.rst
Normal file
17
doc/scripts/base/protocols/mysql/index.rst
Normal file
|
@ -0,0 +1,17 @@
|
|||
:orphan:
|
||||
|
||||
Package: base/protocols/mysql
|
||||
=============================
|
||||
|
||||
Support for MySQL protocol analysis.
|
||||
|
||||
:doc:`/scripts/base/protocols/mysql/__load__.bro`
|
||||
|
||||
|
||||
:doc:`/scripts/base/protocols/mysql/main.bro`
|
||||
|
||||
Implements base functionality for MySQL analysis. Generates the mysql.log file.
|
||||
|
||||
:doc:`/scripts/base/protocols/mysql/consts.bro`
|
||||
|
||||
|
77
doc/scripts/base/protocols/mysql/main.bro.rst
Normal file
77
doc/scripts/base/protocols/mysql/main.bro.rst
Normal file
|
@ -0,0 +1,77 @@
|
|||
:tocdepth: 3
|
||||
|
||||
base/protocols/mysql/main.bro
|
||||
=============================
|
||||
.. bro:namespace:: MySQL
|
||||
|
||||
Implements base functionality for MySQL analysis. Generates the mysql.log file.
|
||||
|
||||
:Namespace: MySQL
|
||||
:Imports: :doc:`base/protocols/mysql/consts.bro </scripts/base/protocols/mysql/consts.bro>`
|
||||
|
||||
Summary
|
||||
~~~~~~~
|
||||
Types
|
||||
#####
|
||||
=========================================== =
|
||||
:bro:type:`MySQL::Info`: :bro:type:`record`
|
||||
=========================================== =
|
||||
|
||||
Redefinitions
|
||||
#############
|
||||
========================================== =
|
||||
:bro:type:`Log::ID`: :bro:type:`enum`
|
||||
:bro:type:`connection`: :bro:type:`record`
|
||||
========================================== =
|
||||
|
||||
Events
|
||||
######
|
||||
============================================= =====================================================================
|
||||
:bro:id:`MySQL::log_mysql`: :bro:type:`event` Event that can be handled to access the MySQL record as it is sent on
|
||||
to the logging framework.
|
||||
============================================= =====================================================================
|
||||
|
||||
|
||||
Detailed Interface
|
||||
~~~~~~~~~~~~~~~~~~
|
||||
Types
|
||||
#####
|
||||
.. bro:type:: MySQL::Info
|
||||
|
||||
:Type: :bro:type:`record`
|
||||
|
||||
ts: :bro:type:`time` :bro:attr:`&log`
|
||||
Timestamp for when the event happened.
|
||||
|
||||
uid: :bro:type:`string` :bro:attr:`&log`
|
||||
Unique ID for the connection.
|
||||
|
||||
id: :bro:type:`conn_id` :bro:attr:`&log`
|
||||
The connection's 4-tuple of endpoint addresses/ports.
|
||||
|
||||
cmd: :bro:type:`string` :bro:attr:`&log`
|
||||
The command that was issued
|
||||
|
||||
arg: :bro:type:`string` :bro:attr:`&log`
|
||||
The argument issued to the command
|
||||
|
||||
success: :bro:type:`bool` :bro:attr:`&log` :bro:attr:`&optional`
|
||||
Did the server tell us that the command succeeded?
|
||||
|
||||
rows: :bro:type:`count` :bro:attr:`&log` :bro:attr:`&optional`
|
||||
The number of affected rows, if any
|
||||
|
||||
response: :bro:type:`string` :bro:attr:`&log` :bro:attr:`&optional`
|
||||
Server message, if any
|
||||
|
||||
|
||||
Events
|
||||
######
|
||||
.. bro:id:: MySQL::log_mysql
|
||||
|
||||
:Type: :bro:type:`event` (rec: :bro:type:`MySQL::Info`)
|
||||
|
||||
Event that can be handled to access the MySQL record as it is sent on
|
||||
to the logging framework.
|
||||
|
||||
|
Loading…
Add table
Add a link
Reference in a new issue