nicolargo / glances

glances/exports/glances_cassandra.py

# -*- coding: utf-8 -*-
#
# This file is part of Glances.
#
# Copyright (C) 2019 Nicolargo <nicolas@nicolargo.com>
#
# Glances is free software; you can redistribute it and/or modify
# it under the terms of the GNU Lesser General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# Glances is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.

"""Cassandra/Scylla interface class."""

import sys

import missing from __future__ import absolute_import

from datetime import datetime
from numbers import Number

import missing from __future__ import absolute_import

from glances.logger import logger

import missing from __future__ import absolute_import

from glances.exports.glances_export import GlancesExport

import missing from __future__ import absolute_import

from glances.compat import iteritems

import missing from __future__ import absolute_import

Unused iteritems imported from glances.compat

from cassandra.auth import PlainTextAuthProvider
from cassandra.cluster import Cluster

import missing from __future__ import absolute_import

Unable to import 'cassandra.cluster'

from cassandra.util import uuid_from_time

import missing from __future__ import absolute_import

Unable to import 'cassandra.util'

from cassandra import InvalidRequest

import missing from __future__ import absolute_import

Unable to import 'cassandra'

class Export(GlancesExport):

Too many instance attributes (9/7)

    """This class manages the Cassandra/Scylla export module."""

    def __init__(self, config=None, args=None):
        """Init the Cassandra export IF."""
        super(Export, self).__init__(config=config, args=args)

        # Mandatories configuration keys (additional to host and port)
        self.keyspace = None

        # Optionals configuration keys
        self.protocol_version = 3
        self.replication_factor = 2
        self.table = None
        self.username = None
        self.password = None

        # Load the Cassandra configuration file section
        self.export_enable = self.load_conf('cassandra',
                                            mandatories=['host', 'port', 'keyspace'],

This line is too long as per the coding-style (85/80).

                                            options=['protocol_version',
                                                     'replication_factor',
                                                     'table',
                                                     'username',
                                                     'password'])
        if not self.export_enable:
            sys.exit(2)

        # Init the Cassandra client
        self.cluster, self.session = self.init()

    def init(self):
        """Init the connection to the Cassandra server."""
        if not self.export_enable:
            return None

        # if username and/or password are not set the connection will try to connect with no auth
        auth_provider = PlainTextAuthProvider(
            username=self.username, password=self.password)

        # Cluster
        try:
            cluster = Cluster([self.host],
                              port=int(self.port),
                              protocol_version=int(self.protocol_version),
                              auth_provider=auth_provider)
            session = cluster.connect()
        except Exception as e:

Catching very general exceptions such as Exception is usually not recommended.

The name e does not conform to the variable naming conventions ((([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$).

            logger.critical("Cannot connect to Cassandra cluster '%s:%s' (%s)" % (self.host, self.port, e))

This line is too long as per the coding-style (107/80).

Specify string format arguments as logging function parameters

            sys.exit(2)

        # Keyspace
        try:
            session.set_keyspace(self.keyspace)

The variable session does not seem to be defined for all execution paths.

        except InvalidRequest as e:

The name e does not conform to the variable naming conventions ((([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$).

            logger.info("Create keyspace {} on the Cassandra cluster".format(self.keyspace))

This line is too long as per the coding-style (92/80).

Use formatting in logging functions and pass the parameters as arguments

            c = "CREATE KEYSPACE %s WITH replication = { 'class': 'SimpleStrategy', 'replication_factor': '%s' }" % (self.keyspace, self.replication_factor)

This line is too long as per the coding-style (156/80).

The name c does not conform to the variable naming conventions ((([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$).

            session.execute(c)
            session.set_keyspace(self.keyspace)

        logger.info(
            "Stats will be exported to Cassandra cluster {} ({}) in keyspace {}".format(
                cluster.metadata.cluster_name, cluster.metadata.all_hosts(), self.keyspace))

        # Table
        try:
            session.execute("CREATE TABLE %s (plugin text, time timeuuid, stat map<text,float>, PRIMARY KEY (plugin, time)) WITH CLUSTERING ORDER BY (time DESC)" % self.table)

This line is too long as per the coding-style (175/80).

        except Exception:
            logger.debug("Cassandra table %s already exist" % self.table)

Specify string format arguments as logging function parameters

        return cluster, session

    def export(self, name, columns, points):
        """Write the points to the Cassandra cluster."""
        logger.debug("Export {} stats to Cassandra".format(name))

Use formatting in logging functions and pass the parameters as arguments

        # Remove non number stats and convert all to float (for Boolean)
        data = {k: float(v) for (k, v) in dict(zip(columns, points)).iteritems() if isinstance(v, Number)}

This line is too long as per the coding-style (106/80).

        # Write input to the Cassandra table
        try:

            stmt = "INSERT INTO {} (plugin, time, stat) VALUES (?, ?, ?)".format(self.table)
            query = self.session.prepare(stmt)
            self.session.execute(
                query,
                (name, uuid_from_time(datetime.now()), data)
            )
        except Exception as e:

Catching very general exceptions such as Exception is usually not recommended.

The name e does not conform to the variable naming conventions ((([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$).

            logger.error("Cannot export {} stats to Cassandra ({})".format(name, e))

This line is too long as per the coding-style (84/80).

Use formatting in logging functions and pass the parameters as arguments

    def exit(self):
        """Close the Cassandra export module."""
        # To ensure all connections are properly closed
        self.session.shutdown()
        self.cluster.shutdown()
        # Call the father method
        super(Export, self).exit()