Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Modernize common/check_messages_to_submit #144

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
75 changes: 35 additions & 40 deletions common/check_messages_to_submit
Original file line number Diff line number Diff line change
@@ -1,62 +1,57 @@
#!/usr/bin/env python
# Copyright European Organization for Nuclear Research (CERN) 2013
#!/usr/bin/env python3
# Copyright European Organization for Nuclear Research (CERN) since 2012
#
# Licensed under the Apache License, Version 2.0 (the "License");
# You may not use this file except in compliance with the License.
# You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# Authors:
# - Mario Lassnig, <[email protected]>, 2013-2014
# - Thomas Beermann, <[email protected]>, 2019
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

"""
Probe to check the queues of messages to submit by Hermes to the broker
"""
from __future__ import print_function

import sys
import traceback

from sqlalchemy import func, select

from prometheus_client import CollectorRegistry, Gauge, push_to_gateway
from rucio.common.config import config_get
from rucio.db.sqla.session import BASE, get_session
from rucio.db.sqla import models
from rucio.db.sqla.session import get_session

from utils.common import probe_metrics
from utils.common import PrometheusPusher

# Exit statuses
OK, WARNING, CRITICAL, UNKNOWN = 0, 1, 2, 3

if BASE.metadata.schema:
schema = BASE.metadata.schema + '.'
else:
schema = ''

queue_sql = """SELECT COUNT(*) FROM {schema}messages""".format(schema=schema)

PROM_SERVERS = config_get('monitor', 'prometheus_servers', raise_exception=False, default='')
if PROM_SERVERS != '':
PROM_SERVERS = PROM_SERVERS.split(',')

if __name__ == "__main__":
try:
registry = CollectorRegistry()
session = get_session()
result = session.execute(queue_sql).fetchall()
print('queues.messages %s' % result[0][0])
probe_metrics.gauge(name='queues.messages').set(result[0][0])
Gauge('hermes_queues_messages', '', registry=registry).set(result[0][0])

if len(PROM_SERVERS):
for server in PROM_SERVERS:
try:
push_to_gateway(server.strip(), job='check_messages_to_submit', registry=registry)
except:
continue

if result[0][0] > 100000:
statement = select(
func.count()
).select_from(
models.Message
)
message_count = session.execute(statement).scalar_one()
print(f"queue.messages {message_count}")

with PrometheusPusher() as manager:
(manager.gauge(
"messages_to_submit.queues.messages",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Requires further review.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This changes the metric value, but is fine for CMS. I think the long-discussed goal is to group things appropriately.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changing the metric name can be acceptable. The problem is that the new metric name is less discoverable than before.

This (and the other two PRs) populate a very inherent metric of the respective daemons: their backlog. So, it’s unconventional to chose a metric name that doesn’t even reference the daemon.

And if the name is changed, then the commit message should very clearly state so.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK. @voetberg let me know if you need help coming up with a better metric name.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Okay, I was populating the new name based off the job name from the gateway push not the gauge itself. I don't see a problem including the name of the daemon here.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please allow me to give it a bit more thought and get back to you. Once this small kink is ironed out, all three PRs can be merged and we can move on to the remaining probes.

documentation="Messages in queue, to submit")
.set(message_count))

if message_count > 100000:
sys.exit(WARNING)
elif result[0][0] > 1000000:
elif message_count > 1000000:
sys.exit(CRITICAL)

except Exception as e:
except Exception:
print(traceback.format_exc())
sys.exit(UNKNOWN)
sys.exit(OK)