doc: Update documentation and configuration for Prometheus extractor

Co-authored-by: alvarolopez <[email protected]>

Author: Copilot

caso/opts.py

@@ -21,6 +21,7 @@
 import caso.extract.base
 import caso.extract.manager
 import caso.extract.openstack.nova
+import caso.extract.prometheus
 import caso.keystone_client
 import caso.manager
 import caso.messenger.logstash
@@ -43,5 +44,6 @@ def list_opts():
         ("benchmark", caso.extract.openstack.nova.benchmark_opts),
         ("keystone_auth", caso.keystone_client.opts),
         ("logstash", caso.messenger.logstash.opts),
+        ("prometheus", caso.extract.prometheus.opts),
         ("ssm", caso.messenger.ssm.opts),
     ]

doc/source/configuration.rst

@@ -121,8 +121,15 @@ config file (``/etc/caso/caso.conf.sample``) includes a description
 of every option. You should check at least the following options:
 
 * ``extractor`` (default value: ``nova``), specifies which extractor to use for
-  getting the data. The following APIs are supported: ``ceilomenter`` and
-  ``nova``. Both should generate equivalent information.
+  getting the data. The following extractors are available:
+  
+      * ``nova`` - Extract VM accounting records from OpenStack Nova
+      * ``cinder`` - Extract storage accounting records from OpenStack Cinder
+      * ``neutron`` - Extract network/IP accounting records from OpenStack Neutron
+      * ``prometheus`` - Extract energy consumption metrics from Prometheus
+  
+  You can configure multiple extractors by providing a list (e.g., 
+  ``nova,cinder,prometheus``).
 * ``site_name`` (default value: ``<None>``). Name of the site as defined in
   GOCDB.
 * ``service_name`` (default value: ``$site_name``). Name of the service within
@@ -201,6 +208,25 @@ messenger. Available options:
 * ``host`` (default: ``localhost``), host of Logstash server.
 * ``port`` (default: ``5000``), Logstash server port.
 
+``[prometheus]`` section
+------------------------
+
+Options defined here configure the Prometheus extractor for gathering energy
+consumption metrics. This extractor queries a Prometheus instance to retrieve
+energy usage data. Available options:
+
+* ``prometheus_endpoint`` (default: ``http://localhost:9090``), Prometheus
+  server endpoint URL.
+* ``prometheus_query`` (default: 
+  ``sum(rate(node_energy_joules_total[5m])) * 300 / 3600000``), PromQL query
+  to retrieve energy consumption in kWh. This query should return energy 
+  consumption metrics that will be converted to accounting records.
+* ``prometheus_timeout`` (default: ``30``), Timeout for Prometheus API
+  requests in seconds.
+
+To use the Prometheus extractor, add ``prometheus`` to the ``extractor`` option
+in the main configuration.
+
 Other cASO configuration options
 --------------------------------
 

etc/caso/caso.conf.sample

@@ -37,7 +37,7 @@
 
 # Property key used to get the VO name from the project properties.  (string
 # value)
-#vo_property = accounting:VO
+#vo_property = VO
 
 # DEPRECATED: File containing the VO <-> project mapping as used in Keystone-
 # VOMS. (string value)
@@ -123,11 +123,15 @@
 # Deprecated group/name - [DEFAULT]/logdir
 #log_dir = <None>
 
-# Uses logging handler designed to watch file system. When log file is moved or
-# removed this handler will open a new log file with specified path
+# DEPRECATED: Uses logging handler designed to watch file system. When log file
+# is moved or removed this handler will open a new log file with specified path
 # instantaneously. It makes sense only if log_file option is specified and
 # Linux platform is used. This option is ignored if log_config_append is set.
 # (boolean value)
+# This option is deprecated for removal.
+# Its value may be silently ignored in the future.
+# Reason: This function is known to have bene broken for long time, and depends
+# on the unmaintained library
 #watch_log_file = false
 
 # Use syslog for logging. Existing syslog format is DEPRECATED and will be
@@ -153,9 +157,17 @@
 # set. (boolean value)
 #use_stderr = false
 
-# Log output to Windows Event Log. (boolean value)
+# DEPRECATED: Log output to Windows Event Log. (boolean value)
+# This option is deprecated for removal.
+# Its value may be silently ignored in the future.
+# Reason: Windows support is no longer maintained.
 #use_eventlog = false
 
+# (Optional) Set the 'color' key according to log levels. This option takes
+# effect only when logging to stderr or stdout is used. This option is ignored
+# if log_config_append is set. (boolean value)
+#log_color = false
+
 # The amount of time before the log files are rotated. This option is ignored
 # unless log_rotation_type is set to "interval". (integer value)
 #log_rotate_interval = 1
@@ -228,10 +240,16 @@
 # Maximum number of logged messages per rate_limit_interval. (integer value)
 #rate_limit_burst = 0
 
-# Log level name used by rate limiting: CRITICAL, ERROR, INFO, WARNING, DEBUG
-# or empty string. Logs with level greater or equal to rate_limit_except_level
-# are not filtered. An empty string means that all levels are filtered. (string
-# value)
+# Log level name used by rate limiting. Logs with level greater or equal to
+# rate_limit_except_level are not filtered. An empty string means that all
+# levels are filtered. (string value)
+# Possible values:
+# CRITICAL - <No description provided>
+# ERROR - <No description provided>
+# INFO - <No description provided>
+# WARNING - <No description provided>
+# DEBUG - <No description provided>
+# '' - <No description provided>
 #rate_limit_except_level = CRITICAL
 
 # Enables or disables fatal status of deprecations. (boolean value)
@@ -380,6 +398,23 @@
 #port = 5000
 
 
+[prometheus]
+
+#
+# From caso
+#
+
+# Prometheus server endpoint URL. (string value)
+#prometheus_endpoint = http://localhost:9090
+
+# Prometheus query to retrieve energy consumption in kWh. The query should
+# return energy consumption metrics. (string value)
+#prometheus_query = sum(rate(node_energy_joules_total[5m])) * 300 / 3600000
+
+# Timeout for Prometheus API requests in seconds. (integer value)
+#prometheus_timeout = 30
+
+
 [sample_remote_file_source]
 # Example of using a remote_file source
 #
@@ -439,6 +474,10 @@
 # includes the private key. (string value)
 #client_key = <None>
 
+# Timeout is the number of seconds the request will wait for your client to
+# establish a connection to a remote machine call on the socket. (string value)
+#timeout = 60
+
 
 [ssm]