[Monitoring] Set explicit access option for internal API

[tonyghiani]

📓 Summary

Part of #186781

Explicit set the access options for the monitoring internal API:

• access [internal] [POST] for path [/api/monitoring/v1/alert/{clusterUuid}/status]"
• access [internal] [POST] for path [/api/monitoring/v1/alerts/enable]"
• access [internal] [POST] for path [/api/monitoring/v1/clusters/{clusterUuid}/apm/{apmUuid}]"
• access [internal] [POST] for path [/api/monitoring/v1/clusters/{clusterUuid}/apm/instances]"
• access [internal] [POST] for path [/api/monitoring/v1/clusters/{clusterUuid}/apm]"
• access [internal] [POST] for path [/api/monitoring/v1/clusters/{clusterUuid}/beats/beat/{beatUuid}]"
• access [internal] [POST] for path [/api/monitoring/v1/clusters/{clusterUuid}/beats/beats]"
• access [internal] [POST] for path [/api/monitoring/v1/clusters/{clusterUuid}/beats]"
• access [internal] [GET] for path [/api/monitoring/v1/check_access]"
• access [internal] [POST] for path [/api/monitoring/v1/clusters/{clusterUuid}]"
• access [internal] [POST] for path [/api/monitoring/v1/clusters]"
• access [internal] [POST] for path [/api/monitoring/v1/clusters/{clusterUuid}/elasticsearch/indices/{id}]"
• access [internal] [POST] for path [/api/monitoring/v1/clusters/{clusterUuid}/elasticsearch/indices]"
• access [internal] [POST] for path [/api/monitoring/v1/clusters/{clusterUuid}/elasticsearch/nodes/{nodeUuid}]"
• access [internal] [POST] for path [/api/monitoring/v1/clusters/{clusterUuid}/elasticsearch/nodes]"
• access [internal] [POST] for path [/api/monitoring/v1/clusters/{clusterUuid}/elasticsearch]"
• access [internal] [POST] for path [/api/monitoring/v1/clusters/{clusterUuid}/elasticsearch/ml_jobs]"
• access [internal] [POST] for path [/api/monitoring/v1/clusters/{clusterUuid}/elasticsearch/ccr]"
• access [internal] [POST] for path [/api/monitoring/v1/clusters/{clusterUuid}/elasticsearch/ccr/{index}/shard/{shardId}]"
• access [internal] [GET] for path [/api/monitoring/v1/elasticsearch_settings/check/cluster]"
• access [internal] [POST] for path [/api/monitoring/v1/elasticsearch_settings/check/internal_monitoring]"
• access [internal] [GET] for path [/api/monitoring/v1/elasticsearch_settings/check/nodes]"
• access [internal] [PUT] for path [/api/monitoring/v1/elasticsearch_settings/set/collection_enabled]"
• access [internal] [PUT] for path [/api/monitoring/v1/elasticsearch_settings/set/collection_interval]"
• access [internal] [POST] for path [/api/monitoring/v1/clusters/{clusterUuid}/enterprise_search]"
• access [internal] [GET] for path [/api/monitoring/v1/_health]"
• access [internal] [POST] for path [/api/monitoring/v1/clusters/{clusterUuid}/logstash/pipeline_ids]"
• access [internal] [POST] for path [/api/monitoring/v1/clusters/{clusterUuid}/logstash/pipelines]"
• access [internal] [POST] for path [/api/monitoring/v1/clusters/{clusterUuid}/logstash/node/{logstashUuid}/pipelines]"
• access [internal] [POST] for path [/api/monitoring/v1/clusters/{clusterUuid}/logstash/node/{logstashUuid}]"
• access [internal] [POST] for path [/api/monitoring/v1/clusters/{clusterUuid}/logstash/nodes]"
• access [internal] [POST] for path [/api/monitoring/v1/clusters/{clusterUuid}/logstash]"
• access [internal] [POST] for path [/api/monitoring/v1/clusters/{clusterUuid}/logstash/pipeline/{pipelineId}/{pipelineHash?}]"
• access [internal] [POST] for path [/api/monitoring/v1/setup/collection/cluster/{clusterUuid?}]"
• access [internal] [POST] for path [/api/monitoring/v1/setup/collection/{clusterUuid}/disable_internal_collection]"
• access [internal] [POST] for path [/api/monitoring/v1/setup/collection/node/{nodeUuid}]"
• access [internal] [POST] for path [/api/monitoring/v1/clusters/{clusterUuid}/kibana/{kibanaUuid}]"
• access [internal] [POST] for path [/api/monitoring/v1/clusters/{clusterUuid}/kibana/instances]"
• access [internal] [POST] for path [/api/monitoring/v1/clusters/{clusterUuid}/kibana]"
• access [internal] [GET] for path [/api/monitoring_collection/{type}]

[obltmachine]

🤖 GitHub comments

Expand to view the GitHub comments

Just comment with:

• /oblt-deploy : Deploy a Kibana instance using the Observability test environments.
• run docs-build : Re-trigger the docs validation. (use unformatted text in the comment!)

[jennypavlova]

LGTM

[kibana-ci]

💚 Build Succeeded

• Buildkite Build
• Commit: 452c550

Metrics [docs]

✅ unchanged

History

• 💛 Build #217687 was flaky 932b37b
• 💛 Build #217632 was flaky 1c54426

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

[consulthys]

access [internal] [GET] for path [/api/monitoring_collection/{type}]

@tonyghiani I'm questioning the rationale behind flagging this endpoint as internal. The reason being that it is called from the kibana Metricbeat module in order to monitor Kibana. By definition, the kibana agent integration also needs it.

Should we "move" this endpoint to the public API?

[tonyghiani]

Sorry for the late response @consulthys, I marked this endpoint as internal as it was reported in the list of the internal endpoints in the related issue. If this should be a public API, it makes sense to move it then 👌

[piotrp]

So I guess this is the reason for WARN spam in new Kibana versions?

[2024-12-09T12:01:01.860+01:00][WARN ][http.server.kbn-internal-api-restricted] Access to uri [/api/monitoring_collection/cluster_rules] with method [get] is deprecated
[2024-12-09T12:01:01.898+01:00][WARN ][http.server.kbn-internal-api-restricted] Access to uri [/api/monitoring_collection/node_actions] with method [get] is deprecated
[2024-12-09T12:01:02.605+01:00][WARN ][http.server.kbn-internal-api-restricted] Access to uri [/api/monitoring_collection/cluster_actions] with method [get] is deprecated
[2024-12-09T12:01:05.976+01:00][WARN ][http.server.kbn-internal-api-restricted] Access to uri [/api/monitoring_collection/node_rules] with method [get] is deprecated
[2024-12-09T12:01:11.859+01:00][WARN ][http.server.kbn-internal-api-restricted] Access to uri [/api/monitoring_collection/cluster_rules] with method [get] is deprecated
[2024-12-09T12:01:11.898+01:00][WARN ][http.server.kbn-internal-api-restricted] Access to uri [/api/monitoring_collection/node_actions] with method [get] is deprecated
[2024-12-09T12:01:12.606+01:00][WARN ][http.server.kbn-internal-api-restricted] Access to uri [/api/monitoring_collection/cluster_actions] with method [get] is deprecated
[2024-12-09T12:01:15.990+01:00][WARN ][http.server.kbn-internal-api-restricted] Access to uri [/api/monitoring_collection/node_rules] with method [get] is deprecated
[2024-12-09T12:01:21.860+01:00][WARN ][http.server.kbn-internal-api-restricted] Access to uri [/api/monitoring_collection/cluster_rules] with method [get] is deprecated
[2024-12-09T12:01:21.898+01:00][WARN ][http.server.kbn-internal-api-restricted] Access to uri [/api/monitoring_collection/node_actions] with method [get] is deprecated