[9.0](backport #44793) [documentation][exported-fields] update autogeneration scripts to generate markdown #44803

mergify · 2025-06-13T10:11:34Z

Proposed commit message

This is a follow-up of #44638.
This PR takes care of autogeneration of exported-fields.md document for each beat.

Unfortunately, it is not possible to break down this into PR for each beat because this particular autogeneration script is shared by each beat and is under libbeat. Updating dev-tools/mage/docs.go and libbeat/scripts/generate_fields_docs.py will update generate exported-fields for each beat.

Checklist

My code follows the style guidelines of this project
I have commented my code, particularly in hard-to-understand areas
I have made corresponding changes to the documentation
I have made corresponding change to the default configuration files
I have added tests that prove my fix is effective or that my feature works
I have added an entry in CHANGELOG.next.asciidoc or CHANGELOG-developer.next.asciidoc.

How to test this PR

Head to docs-preview and verify the docs the Exported Fields section for each beat.

Related issues

Relates Update Beats code to support new Markdown documentation #43008

This is an automatic backport of pull request #44793 done by [Mergify](https://mergify.com).

…erate markdown (#44793) * chore: port asciidoc scripts to markdown * fix docs preview * add meraki description * make check (cherry picked from commit 00dcc0c) # Conflicts: # docs/reference/metricbeat/exported-fields-nats.md # libbeat/scripts/generate_fields_docs.py

mergify · 2025-06-13T10:11:36Z

Cherry-pick of 00dcc0c has failed:

On branch mergify/bp/9.0/pr-44793
Your branch is up to date with 'origin/9.0'.

You are currently cherry-picking commit 00dcc0c03.
  (fix conflicts and run "git cherry-pick --continue")
  (use "git cherry-pick --skip" to skip this patch)
  (use "git cherry-pick --abort" to cancel the cherry-pick operation)

Changes to be committed:
	modified:   dev-tools/mage/docs.go
	modified:   docs/reference/auditbeat/exported-fields-auditd.md
	modified:   docs/reference/auditbeat/exported-fields-beat-common.md
	modified:   docs/reference/auditbeat/exported-fields-cloud.md
	modified:   docs/reference/auditbeat/exported-fields-common.md
	modified:   docs/reference/auditbeat/exported-fields-docker-processor.md
	modified:   docs/reference/auditbeat/exported-fields-ecs.md
	modified:   docs/reference/auditbeat/exported-fields-file_integrity.md
	modified:   docs/reference/auditbeat/exported-fields-host-processor.md
	modified:   docs/reference/auditbeat/exported-fields-jolokia-autodiscover.md
	modified:   docs/reference/auditbeat/exported-fields-kubernetes-processor.md
	modified:   docs/reference/auditbeat/exported-fields-process.md
	modified:   docs/reference/auditbeat/exported-fields-system.md
	modified:   docs/reference/auditbeat/exported-fields.md
	modified:   docs/reference/filebeat/exported-fields-activemq.md
	modified:   docs/reference/filebeat/exported-fields-apache.md
	modified:   docs/reference/filebeat/exported-fields-auditd.md
	modified:   docs/reference/filebeat/exported-fields-aws-cloudwatch.md
	modified:   docs/reference/filebeat/exported-fields-aws.md
	modified:   docs/reference/filebeat/exported-fields-awsfargate.md
	modified:   docs/reference/filebeat/exported-fields-azure.md
	modified:   docs/reference/filebeat/exported-fields-beat-common.md
	modified:   docs/reference/filebeat/exported-fields-cef-module.md
	modified:   docs/reference/filebeat/exported-fields-cef.md
	modified:   docs/reference/filebeat/exported-fields-checkpoint.md
	modified:   docs/reference/filebeat/exported-fields-cisco.md
	modified:   docs/reference/filebeat/exported-fields-cloud.md
	modified:   docs/reference/filebeat/exported-fields-coredns.md
	modified:   docs/reference/filebeat/exported-fields-crowdstrike.md
	modified:   docs/reference/filebeat/exported-fields-cyberarkpas.md
	modified:   docs/reference/filebeat/exported-fields-docker-processor.md
	modified:   docs/reference/filebeat/exported-fields-ecs.md
	modified:   docs/reference/filebeat/exported-fields-elasticsearch.md
	modified:   docs/reference/filebeat/exported-fields-envoyproxy.md
	modified:   docs/reference/filebeat/exported-fields-fortinet.md
	modified:   docs/reference/filebeat/exported-fields-gcp.md
	modified:   docs/reference/filebeat/exported-fields-google_workspace.md
	modified:   docs/reference/filebeat/exported-fields-haproxy.md
	modified:   docs/reference/filebeat/exported-fields-host-processor.md
	modified:   docs/reference/filebeat/exported-fields-ibmmq.md
	modified:   docs/reference/filebeat/exported-fields-icinga.md
	modified:   docs/reference/filebeat/exported-fields-iis.md
	modified:   docs/reference/filebeat/exported-fields-iptables.md
	modified:   docs/reference/filebeat/exported-fields-jolokia-autodiscover.md
	modified:   docs/reference/filebeat/exported-fields-juniper.md
	modified:   docs/reference/filebeat/exported-fields-kafka.md
	modified:   docs/reference/filebeat/exported-fields-kibana.md
	modified:   docs/reference/filebeat/exported-fields-kubernetes-processor.md
	modified:   docs/reference/filebeat/exported-fields-log.md
	modified:   docs/reference/filebeat/exported-fields-logstash.md
	modified:   docs/reference/filebeat/exported-fields-lumberjack.md
	modified:   docs/reference/filebeat/exported-fields-microsoft.md
	modified:   docs/reference/filebeat/exported-fields-misp.md
	modified:   docs/reference/filebeat/exported-fields-mongodb.md
	modified:   docs/reference/filebeat/exported-fields-mssql.md
	modified:   docs/reference/filebeat/exported-fields-mysql.md
	modified:   docs/reference/filebeat/exported-fields-mysqlenterprise.md
	modified:   docs/reference/filebeat/exported-fields-nats.md
	modified:   docs/reference/filebeat/exported-fields-netflow.md
	modified:   docs/reference/filebeat/exported-fields-nginx.md
	modified:   docs/reference/filebeat/exported-fields-o365.md
	modified:   docs/reference/filebeat/exported-fields-okta.md
	modified:   docs/reference/filebeat/exported-fields-oracle.md
	modified:   docs/reference/filebeat/exported-fields-osquery.md
	modified:   docs/reference/filebeat/exported-fields-panw.md
	modified:   docs/reference/filebeat/exported-fields-pensando.md
	modified:   docs/reference/filebeat/exported-fields-postgresql.md
	modified:   docs/reference/filebeat/exported-fields-process.md
	modified:   docs/reference/filebeat/exported-fields-rabbitmq.md
	modified:   docs/reference/filebeat/exported-fields-redis.md
	modified:   docs/reference/filebeat/exported-fields-s3.md
	modified:   docs/reference/filebeat/exported-fields-salesforce.md
	modified:   docs/reference/filebeat/exported-fields-santa.md
	modified:   docs/reference/filebeat/exported-fields-snyk.md
	modified:   docs/reference/filebeat/exported-fields-sophos.md
	modified:   docs/reference/filebeat/exported-fields-suricata.md
	modified:   docs/reference/filebeat/exported-fields-system.md
	modified:   docs/reference/filebeat/exported-fields-threatintel.md
	modified:   docs/reference/filebeat/exported-fields-traefik.md
	modified:   docs/reference/filebeat/exported-fields-winlog.md
	modified:   docs/reference/filebeat/exported-fields-zeek.md
	modified:   docs/reference/filebeat/exported-fields-zookeeper.md
	modified:   docs/reference/filebeat/exported-fields-zoom.md
	modified:   docs/reference/filebeat/exported-fields.md
	modified:   docs/reference/heartbeat/exported-fields-beat-common.md
	modified:   docs/reference/heartbeat/exported-fields-browser.md
	modified:   docs/reference/heartbeat/exported-fields-cloud.md
	modified:   docs/reference/heartbeat/exported-fields-common.md
	modified:   docs/reference/heartbeat/exported-fields-docker-processor.md
	modified:   docs/reference/heartbeat/exported-fields-ecs.md
	modified:   docs/reference/heartbeat/exported-fields-host-processor.md
	modified:   docs/reference/heartbeat/exported-fields-http.md
	modified:   docs/reference/heartbeat/exported-fields-icmp.md
	modified:   docs/reference/heartbeat/exported-fields-jolokia-autodiscover.md
	modified:   docs/reference/heartbeat/exported-fields-kubernetes-processor.md
	modified:   docs/reference/heartbeat/exported-fields-process.md
	modified:   docs/reference/heartbeat/exported-fields-resolve.md
	modified:   docs/reference/heartbeat/exported-fields-service.md
	modified:   docs/reference/heartbeat/exported-fields-socks5.md
	modified:   docs/reference/heartbeat/exported-fields-state.md
	modified:   docs/reference/heartbeat/exported-fields-summary.md
	modified:   docs/reference/heartbeat/exported-fields-synthetics.md
	modified:   docs/reference/heartbeat/exported-fields-tcp.md
	modified:   docs/reference/heartbeat/exported-fields-tls.md
	modified:   docs/reference/heartbeat/exported-fields.md
	modified:   docs/reference/metricbeat/exported-fields-activemq.md
	modified:   docs/reference/metricbeat/exported-fields-aerospike.md
	modified:   docs/reference/metricbeat/exported-fields-airflow.md
	modified:   docs/reference/metricbeat/exported-fields-apache.md
	new file:   docs/reference/metricbeat/exported-fields-autoops_es.md
	modified:   docs/reference/metricbeat/exported-fields-aws.md
	modified:   docs/reference/metricbeat/exported-fields-awsfargate.md
	modified:   docs/reference/metricbeat/exported-fields-azure.md
	modified:   docs/reference/metricbeat/exported-fields-beat-common.md
	modified:   docs/reference/metricbeat/exported-fields-beat.md
	modified:   docs/reference/metricbeat/exported-fields-benchmark.md
	modified:   docs/reference/metricbeat/exported-fields-ceph.md
	modified:   docs/reference/metricbeat/exported-fields-cloud.md
	modified:   docs/reference/metricbeat/exported-fields-cloudfoundry.md
	modified:   docs/reference/metricbeat/exported-fields-cockroachdb.md
	modified:   docs/reference/metricbeat/exported-fields-common.md
	modified:   docs/reference/metricbeat/exported-fields-consul.md
	modified:   docs/reference/metricbeat/exported-fields-containerd.md
	modified:   docs/reference/metricbeat/exported-fields-coredns.md
	modified:   docs/reference/metricbeat/exported-fields-couchbase.md
	modified:   docs/reference/metricbeat/exported-fields-couchdb.md
	modified:   docs/reference/metricbeat/exported-fields-docker-processor.md
	modified:   docs/reference/metricbeat/exported-fields-docker.md
	modified:   docs/reference/metricbeat/exported-fields-dropwizard.md
	modified:   docs/reference/metricbeat/exported-fields-ecs.md
	modified:   docs/reference/metricbeat/exported-fields-elasticsearch.md
	modified:   docs/reference/metricbeat/exported-fields-envoyproxy.md
	modified:   docs/reference/metricbeat/exported-fields-etcd.md
	modified:   docs/reference/metricbeat/exported-fields-gcp.md
	modified:   docs/reference/metricbeat/exported-fields-golang.md
	modified:   docs/reference/metricbeat/exported-fields-graphite.md
	modified:   docs/reference/metricbeat/exported-fields-haproxy.md
	modified:   docs/reference/metricbeat/exported-fields-host-processor.md
	modified:   docs/reference/metricbeat/exported-fields-http.md
	modified:   docs/reference/metricbeat/exported-fields-ibmmq.md
	modified:   docs/reference/metricbeat/exported-fields-iis.md
	modified:   docs/reference/metricbeat/exported-fields-istio.md
	modified:   docs/reference/metricbeat/exported-fields-jolokia-autodiscover.md
	modified:   docs/reference/metricbeat/exported-fields-jolokia.md
	modified:   docs/reference/metricbeat/exported-fields-kafka.md
	modified:   docs/reference/metricbeat/exported-fields-kibana.md
	modified:   docs/reference/metricbeat/exported-fields-kubernetes-processor.md
	modified:   docs/reference/metricbeat/exported-fields-kubernetes.md
	modified:   docs/reference/metricbeat/exported-fields-kvm.md
	modified:   docs/reference/metricbeat/exported-fields-linux.md
	modified:   docs/reference/metricbeat/exported-fields-logstash.md
	modified:   docs/reference/metricbeat/exported-fields-memcached.md
	new file:   docs/reference/metricbeat/exported-fields-meraki.md
	modified:   docs/reference/metricbeat/exported-fields-mongodb.md
	modified:   docs/reference/metricbeat/exported-fields-mssql.md
	modified:   docs/reference/metricbeat/exported-fields-munin.md
	modified:   docs/reference/metricbeat/exported-fields-mysql.md
	modified:   docs/reference/metricbeat/exported-fields-nginx.md
	modified:   docs/reference/metricbeat/exported-fields-openai.md
	modified:   docs/reference/metricbeat/exported-fields-openmetrics.md
	modified:   docs/reference/metricbeat/exported-fields-oracle.md
	modified:   docs/reference/metricbeat/exported-fields-panw.md
	modified:   docs/reference/metricbeat/exported-fields-php_fpm.md
	modified:   docs/reference/metricbeat/exported-fields-postgresql.md
	modified:   docs/reference/metricbeat/exported-fields-process.md
	modified:   docs/reference/metricbeat/exported-fields-prometheus-xpack.md
	modified:   docs/reference/metricbeat/exported-fields-prometheus.md
	modified:   docs/reference/metricbeat/exported-fields-rabbitmq.md
	modified:   docs/reference/metricbeat/exported-fields-redis.md
	modified:   docs/reference/metricbeat/exported-fields-redisenterprise.md
	modified:   docs/reference/metricbeat/exported-fields-sql.md
	modified:   docs/reference/metricbeat/exported-fields-stan.md
	modified:   docs/reference/metricbeat/exported-fields-statsd.md
	modified:   docs/reference/metricbeat/exported-fields-syncgateway.md
	modified:   docs/reference/metricbeat/exported-fields-system.md
	modified:   docs/reference/metricbeat/exported-fields-tomcat.md
	modified:   docs/reference/metricbeat/exported-fields-traefik.md
	modified:   docs/reference/metricbeat/exported-fields-uwsgi.md
	modified:   docs/reference/metricbeat/exported-fields-vsphere.md
	modified:   docs/reference/metricbeat/exported-fields-windows.md
	modified:   docs/reference/metricbeat/exported-fields-zookeeper.md
	modified:   docs/reference/metricbeat/exported-fields.md
	modified:   docs/reference/metricbeat/metricbeat-metricset-meraki-device_health.md
	modified:   docs/reference/packetbeat/exported-fields-amqp.md
	modified:   docs/reference/packetbeat/exported-fields-beat-common.md
	modified:   docs/reference/packetbeat/exported-fields-cassandra.md
	modified:   docs/reference/packetbeat/exported-fields-cloud.md
	modified:   docs/reference/packetbeat/exported-fields-common.md
	modified:   docs/reference/packetbeat/exported-fields-dhcpv4.md
	modified:   docs/reference/packetbeat/exported-fields-dns.md
	modified:   docs/reference/packetbeat/exported-fields-docker-processor.md
	modified:   docs/reference/packetbeat/exported-fields-ecs.md
	modified:   docs/reference/packetbeat/exported-fields-flows_event.md
	modified:   docs/reference/packetbeat/exported-fields-host-processor.md
	modified:   docs/reference/packetbeat/exported-fields-http.md
	modified:   docs/reference/packetbeat/exported-fields-icmp.md
	modified:   docs/reference/packetbeat/exported-fields-jolokia-autodiscover.md
	modified:   docs/reference/packetbeat/exported-fields-kubernetes-processor.md
	modified:   docs/reference/packetbeat/exported-fields-memcache.md
	modified:   docs/reference/packetbeat/exported-fields-mongodb.md
	modified:   docs/reference/packetbeat/exported-fields-mysql.md
	modified:   docs/reference/packetbeat/exported-fields-nfs.md
	modified:   docs/reference/packetbeat/exported-fields-pgsql.md
	modified:   docs/reference/packetbeat/exported-fields-process.md
	modified:   docs/reference/packetbeat/exported-fields-raw.md
	modified:   docs/reference/packetbeat/exported-fields-redis.md
	modified:   docs/reference/packetbeat/exported-fields-sip.md
	modified:   docs/reference/packetbeat/exported-fields-thrift.md
	modified:   docs/reference/packetbeat/exported-fields-tls_detailed.md
	modified:   docs/reference/packetbeat/exported-fields-trans_event.md
	modified:   docs/reference/packetbeat/exported-fields-trans_measurements.md
	modified:   docs/reference/packetbeat/exported-fields.md
	modified:   docs/reference/toc.yml
	modified:   docs/reference/winlogbeat/exported-fields-beat-common.md
	modified:   docs/reference/winlogbeat/exported-fields-cloud.md
	modified:   docs/reference/winlogbeat/exported-fields-docker-processor.md
	modified:   docs/reference/winlogbeat/exported-fields-ecs.md
	modified:   docs/reference/winlogbeat/exported-fields-eventlog.md
	modified:   docs/reference/winlogbeat/exported-fields-host-processor.md
	modified:   docs/reference/winlogbeat/exported-fields-jolokia-autodiscover.md
	modified:   docs/reference/winlogbeat/exported-fields-kubernetes-processor.md
	modified:   docs/reference/winlogbeat/exported-fields-powershell.md
	modified:   docs/reference/winlogbeat/exported-fields-process.md
	modified:   docs/reference/winlogbeat/exported-fields-security.md
	modified:   docs/reference/winlogbeat/exported-fields-sysmon.md
	modified:   docs/reference/winlogbeat/exported-fields-winlog.md
	modified:   docs/reference/winlogbeat/exported-fields.md
	modified:   libbeat/scripts/Makefile

Unmerged paths:
  (use "git add <file>..." to mark resolution)
	both modified:   docs/reference/metricbeat/exported-fields-nats.md
	both modified:   libbeat/scripts/generate_fields_docs.py

To fix up this pull request, you can check it out locally. See documentation: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/checking-out-pull-requests-locally

elasticmachine · 2025-06-13T10:11:49Z

Pinging @elastic/elastic-agent-data-plane (Team:Elastic-Agent-Data-Plane)

mergify · 2025-06-16T04:02:28Z

This pull request has not been merged yet. Could you please review and merge it @VihasMakwana? 🙏

mergify bot added backport conflicts There is a conflict in the backported pull request labels Jun 13, 2025

mergify bot requested review from a team as code owners June 13, 2025 10:11

mergify bot assigned VihasMakwana Jun 13, 2025

mergify bot requested review from faec and leehinman and removed request for a team June 13, 2025 10:11

botelastic bot added the needs_team Indicates that the issue/PR needs a Team:* label label Jun 13, 2025

github-actions bot added enhancement docs Team:Elastic-Agent-Data-Plane Label for the Agent Data Plane team labels Jun 13, 2025

botelastic bot removed the needs_team Indicates that the issue/PR needs a Team:* label label Jun 13, 2025

VihasMakwana and others added 2 commits June 13, 2025 16:35

merge conflicts

664ad16

Merge branch '9.0' into mergify/bp/9.0/pr-44793

ee1a552

VihasMakwana approved these changes Jun 13, 2025

View reviewed changes

exported docs

01e411f

VihasMakwana merged commit 3e2fd02 into 9.0 Jun 17, 2025
173 of 177 checks passed

VihasMakwana deleted the mergify/bp/9.0/pr-44793 branch June 17, 2025 14:44

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

[9.0](backport #44793) [documentation][exported-fields] update autogeneration scripts to generate markdown #44803

[9.0](backport #44793) [documentation][exported-fields] update autogeneration scripts to generate markdown #44803

Uh oh!

mergify bot commented Jun 13, 2025

Uh oh!

mergify bot commented Jun 13, 2025

Uh oh!

elasticmachine commented Jun 13, 2025

Uh oh!

mergify bot commented Jun 16, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

[9.0](backport #44793) [documentation][exported-fields] update autogeneration scripts to generate markdown #44803

[9.0](backport #44793) [documentation][exported-fields] update autogeneration scripts to generate markdown #44803

Uh oh!

Conversation

mergify bot commented Jun 13, 2025

Proposed commit message

Checklist

How to test this PR

Related issues

Uh oh!

mergify bot commented Jun 13, 2025

Uh oh!

elasticmachine commented Jun 13, 2025

Uh oh!

mergify bot commented Jun 16, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants