mirror of
https://github.com/zeek/zeek.git
synced 2025-10-09 10:08: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
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