introduce logging without source code pollution

Question

this question is nagging in my head for some time now... For logging to be useful it should be every there in the code, but then it makes code hard to read. Like the following code:

public IDictionary<decimal, Status> GetStatus(decimal[] keys)
{
    _logger.Debug("ENTERED GetStatus");

    IDictionary<decimal, Status> statuses = new Dictionary<decimal, Status>();
    string inClause = null;

    inClause = FormatInClause(keys, inClause);
    _logger.DebugFormat(" inClause: '{0}' ", inClause);
    if (string.IsNullOrEmpty(inClause))
    {
        _logger.Error("Key collection is null or empty.");
        throw new Exception("Key collection is null or empty.");
    }

    if (!IsOpen)
        Connection.Open();

    using (IDbCommand cmd = Connection.CreateCommand())
    {
        cmd.CommandText = " select id, date, status " +
            " from ORDERS where id in ( " + inClause + " ) ";

        inClause = null;

        using (IDataReader reader = cmd.ExecuteReader())
        {
            int i = 0;
            while (reader.Read())
            {
                object[] values = new object[reader.FieldCount];

                reader.GetValues(values);
                DebugHelper.LogValues(_logger, " reader.Read() #" + i + " reader.GetValues(values): ", values);

                statuses[(decimal)values[0]] = new Status(
                    (decimal)values[0],
                    ValueOrDefult<string>(values[1]),
                    ValueOrDefult<string>(values[2]),
                    (decimal)values[3],
                    ValueOrDefult<DateTime>(values[4]));
                _logger.DebugFormat(" reader.Read() #{0} created new Status() ", i);

                values = null;
                i++;
            }
        }
    }

    _logger.Debug("EXITED GetStatus");
    return statuses;
}

Is there some strategy for logging not to reduce readability of source code?

Answer 1

Aspect oriented programming is supposed to help with cross-cutting concerns like logging, eg. postsharp but you cannot really have very fine grained control over what is logged unless you resort to more traditional methods

Answer 2

imho your logging is cluttered because your code is so too. You should read up on SOLID principles.

For instance, move the reader code to a separate method.