aboutsummaryrefslogtreecommitdiffstats
path: root/reference/slf4j-reference/src/test/java/org/onap/logging/ref/slf4j/analysis/CallGraphAnalyzer.java
blob: 208b3e13547bd148d2df0afca701708d56516a96 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
/**
 * ============LICENSE_START=======================================================
 * org.onap.logging
 * ================================================================================
 * Copyright © 2018 Amdocs
 * All rights reserved.
 * ================================================================================
 * 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
 *
 * 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.
 * ============LICENSE_END=========================================================
 */

package org.onap.logging.ref.slf4j.analysis;

import java.util.ArrayList;
import java.util.List;

import org.apache.commons.lang3.StringUtils;

/**
 * Crude analyzer for log messages, to build a simple
 * representation of the call graph.
 */
public class CallGraphAnalyzer {

    /** Messages of interest. */
    private List<LogEntry> mEntries = new ArrayList<>();

    /**
     * Capture entry if it's interesting.
     * @param entry candidate.
     * @return this.
     */
    public CallGraphAnalyzer add(final LogEntry entry) {

        if (entry.getLogger().contains("ONAPLogAdapterTest")) {
            return this;
        }

        if (StringUtils.isNotBlank(entry.getMarkers())) {
            this.mEntries.add(entry);
        }

        return this;
    }

    /**
     * Get all captured entries, for diagnostics only.
     * @return entries.
     */
    public List<LogEntry> getEntries() {
        return this.mEntries;
    }

    /**
     * Find the entry point into the call graph through the various components.
     * @return entry point or (failure) null.
     */
    public LogEntry findEntryPoint() {
        for (final LogEntry e : this.mEntries) {
            if (e.getLogger().endsWith("ComponentAlpha")) {
                if ("ENTRY".equals(e.getMarkers())) {
                    if (StringUtils.isBlank(e.getPartnerName())) {
                        return e;
                    }
                }
            }
        }
        return null;
    }

    /**
     * Find entries for where a component invokes others.
     * @param parent parent ENTRY (not actually the entry where it's doing the invoking).
     * @return components invoked by this one.
     */
    public List<LogEntry> findInvokes(final LogEntry parent) {
        final List<LogEntry> invokes = new ArrayList<>();
        for (final LogEntry e : this.mEntries) {
            if (StringUtils.equals(parent.getInvocationID(), e.getInvocationID())) {
                final String invokingID = e.getInvokingID();
                if (StringUtils.isNotBlank(invokingID)) {
                    invokes.add(e);
                }
            }
        }
        return invokes;
    }

    /**
     * Find a specific invocation.
     * @param invoke invocation record.
     * @return invocation ENTRY, or (failure) null if not found.
     */
    public LogEntry findInvocation(final LogEntry invoke) {
        for (final LogEntry e : this.mEntries) {
            if ("ENTRY".equals(e.getMarkers())) {
                if (StringUtils.equals(invoke.getInvokingID(), e.getInvocationID())) {
                    return e;
                }
            }
        }
        return null;
    }
}