logging_idl.idl

Go to the documentation of this file.

/*
 *    ALMA - Atacama Large Millimiter Array
 *    (c) European Southern Observatory, 2002
 *    Copyright by ESO (in the framework of the ALMA collaboration)
 *    and Cosylab 2002, All rights reserved
 *
 *    This library 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 2.1 of the License, or (at your option) any later version.
 *
 *    This library 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 library; if not, write to the Free Software
 *    Foundation, Inc., 59 Temple Place, Suite 330, Boston, 
 *    MA 02111-1307  USA
 */ 
#ifndef _LOGGING_IDL
#define _LOGGING_IDL

#include <DsLogAdmin.idl>

#pragma prefix "alma"



module AcsLogLevels {

        typedef short logLevelValue;
        
        const logLevelValue TRACE_VAL = 1;
        const string TRACE_NAME = "Trace";

        // see COMP-3749 which describes this introduction of a new level between TRACE and DEBUG after ACS 8.1.0
        const logLevelValue DELOUSE_VAL = 2; 
        const string DELOUSE_NAME = "Delouse";

        const logLevelValue DEBUG_VAL = 3;
        const string DEBUG_NAME = "Debug";

        const logLevelValue INFO_VAL = 4;
        const string INFO_NAME = "Info";

        const logLevelValue NOTICE_VAL = 5;
        const string NOTICE_NAME = "Notice";

        const logLevelValue WARNING_VAL = 6;
        const string WARNING_NAME = "Warning";
        
        // anomaly: value 7 is not defined! 

        const logLevelValue ERROR_VAL = 8;
        const string ERROR_NAME = "Error";
        
        const logLevelValue CRITICAL_VAL = 9;
        const string CRITICAL_NAME = "Critical";
        
        const logLevelValue ALERT_VAL = 10;
        const string ALERT_NAME = "Alert";
        
        const logLevelValue EMERGENCY_VAL = 11;
        const string EMERGENCY_NAME = "Emergency";
        
        // The OFF value of 99 is more human friendly. Technically it would make more sense
        // to define OFF_VAL as the maximum allowed value (2^15 - 1).
        const logLevelValue OFF_VAL = 99;
        const string OFF_NAME = "Off";
};


module ACSLoggingLog {

    struct NameValue {
        string name;
        string value; // any ? -> use than Property from Property Service
    };

    typedef sequence<NameValue> NameValueSeq;

    /*
    enum LogType {
        Unknown,
        Shutdown,
        Trace,
        Debug,
        Info,
        Notice,
        Warning,
        Startup,
        Error,
        Critical,
        Alert,
        Emergency,
        Archive
    };
    */
/*
Header,
        Description,
        History,
        Meta,
        Data,
        Alarm,
*/

    struct LogBinaryRecord {
        AcsLogLevels::logLevelValue type;
        string TimeStamp;
        string File;
        unsigned long Line;
        string Routine;
        string SourceObject;
        string Host;
        string Process;
        string LogContext;
        string Thread;
        string StackId;
        long StackLevel;
    string LogId;
        long Priority;
        string Uri;
    string Audience;
    string Array;
    string Antenna;
        string MsgData;
        
    NameValueSeq attributes;
        NameValueSeq log_data;

    };

};


module Logging
{
    typedef sequence <string> stringSeq;

    exception LoggerDoesNotExistEx
    {
        string LoggerName; 
    };
    
    exception IllegalLogLevelsEx
    {
        string ErrorDesc; 
    };
    
    interface LoggingConfigurable {
    
        /*
         * Struct that represents log level thresholds used for filtering log records.
         */
        struct LogLevels {
            boolean useDefault;
            AcsLogLevels::logLevelValue minLogLevel;
            AcsLogLevels::logLevelValue minLogLevelLocal;
        };
    
        LogLevels get_default_logLevels();
       
        void set_default_logLevels(in LogLevels levels)
            raises (IllegalLogLevelsEx);
       
        stringSeq get_logger_names();
       
        LogLevels get_logLevels(in string logger_name)
            raises (LoggerDoesNotExistEx);
       
        void set_logLevels(in string logger_name, in LogLevels levels)
            raises (LoggerDoesNotExistEx, IllegalLogLevelsEx);
    
        oneway void refresh_logging_config();
    };

        struct XmlLogRecord{
                // xml string that represents the Log
                string xml;

                // Log level of the log record
                AcsLogLevels::logLevelValue logLevel;
        };

        struct LogStatistics{
                unsigned long long receivedLogs;
        };

        typedef sequence<XmlLogRecord> XmlLogRecordSeq;


        interface AcsLogService : DsLogAdmin::BasicLog
        {
                void writeRecords(in XmlLogRecordSeq xmlLogRecords);

                LogStatistics getStatistics();
                
        };

        interface ACSLogFactory : DsLogAdmin::BasicLogFactory
        {
        };
        
        interface ACSLogStatistics
        {
        
            /*
                 * Struct that represents the logging statistics information.
                 */
                struct LogStatsInformation
                {
                        string statsId;
                        string loggerName;
                        boolean statsStatus;
                        unsigned long statsPeriodConfiguration;
                        unsigned long statsGranularityConfiguration;
                        
                };
                /*typedef sequence <LogStatsInformation> logStatsInformationSeq;*/
                typedef sequence <LogStatsInformation> logStatsInformationSeq;
                
                ACSLogStatistics::logStatsInformationSeq get_statistics_logger_configuration();
                
                ACSLogStatistics::LogStatsInformation get_statistics_logger_configuration_byname(in string logger_name)
                    raises (LoggerDoesNotExistEx);
                
        void set_statistics_logger_configuration_byname(in string logger_name, in ACSLogStatistics::LogStatsInformation statsInformation)
            raises (LoggerDoesNotExistEx);
                
        };
        
};


#endif