import logging
from pywps import FORMATS, ComplexOutput, LiteralInput, Process
from pywps.app.Common import Metadata
from pywps.app.exceptions import ProcessError
from clisops.parameter import time_parameter
from ..usage import Downloads, WPSUsage
LOGGER = logging.getLogger()
EMPTY_CSV = """\
remote_host_ip,ip_number,datetime,timezone,request_type,request,protocol,status_code,size,referer,user_agent
127.0.0.1,1000000000,2021-01-01 12:00:00,+0200,GET,dummy.nc,HTTP/1.1,200,1000000,-,python
""" # noqa
[docs]
class Usage(Process):
def __init__(self):
inputs = [
LiteralInput(
"time",
"Time Period",
abstract="The time period for usage collection separated by /"
"Example: 2024-06-01/2024-06-30",
data_type="string",
min_occurs=0,
max_occurs=1,
),
]
outputs = [
ComplexOutput(
"wpsusage",
"WPSUsage",
abstract="OGC:WPS metrics collected from pywps database.",
as_reference=True,
supported_formats=[FORMATS.CSV],
),
ComplexOutput(
"downloads",
"Downloads",
abstract="Downloads collected from nginx log file.",
as_reference=True,
supported_formats=[FORMATS.CSV],
),
]
super().__init__(
self._handler,
identifier="usage",
title="Usage",
abstract="Run usage collector.",
metadata=[
Metadata("ROOK", "https://github.com/roocs/rook"),
],
version="0.4",
inputs=inputs,
outputs=outputs,
store_supported=True,
status_supported=True,
)
def _handler(self, request, response):
response.update_status("Usage started.", 0)
if "time" in request.inputs:
time = request.inputs["time"][0].data
time_start, time_end = time_parameter.TimeParameter(time).get_bounds()
else:
time = None
time_start = time_end = None
# usage
try:
usage = WPSUsage()
response.outputs["wpsusage"].file = usage.collect(
time_start=time_start, time_end=time_end, outdir=self.workdir
)
response.update_status("WPSUsage completed.", 50)
except Exception as e:
raise ProcessError(f"{e}")
# downloads
try:
usage = Downloads()
downloads_csv = usage.collect(
time_start=time_start, time_end=time_end, outdir=self.workdir
)
response.outputs["downloads"].file = downloads_csv
except Exception:
LOGGER.exception("downloads collection failed")
response.outputs["downloads"].data = EMPTY_CSV
finally:
response.update_status("Downloads usage completed.", 90)
return response
