gnosis 0.1.0

Gnosis — enterprise knowledge compiler (CLI + library)
Documentation 
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
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139

use crate::ids::{ObjectId, ProviderId};
use crate::knowledge::Entity;
use crate::status::UnderstandingStatus;
use serde::{Deserialize, Serialize};
use std::path::PathBuf;

#[derive(Clone, Debug)]
pub enum PipelineEvent {
    ScanStarted {
        root: PathBuf,
    },
    ScanCompleted {
        objects: u64,
        elapsed_ms: u64,
    },
    ObjectDiscovered {
        id: ObjectId,
        path: PathBuf,
    },
    ObjectQueued {
        id: ObjectId,
        queue_depth: usize,
    },
    ProviderSelected {
        id: ObjectId,
        provider: ProviderId,
        support: String,
    },
    AnalysisStarted {
        id: ObjectId,
        provider: ProviderId,
    },
    AnalysisCompleted {
        id: ObjectId,
        provider: ProviderId,
        status: UnderstandingStatus,
        entities: usize,
        relationships: usize,
    },
    EntityCreated {
        entity: Entity,
    },
    RelationshipCreated {
        kind: String,
        from: String,
        to: String,
    },
    ObjectClassified {
        id: ObjectId,
        status: UnderstandingStatus,
        reason: Option<String>,
    },
    Warning {
        message: String,
    },
    Failure {
        id: Option<ObjectId>,
        message: String,
    },
    ExportStarted {
        path: PathBuf,
    },
    ExportCompleted {
        path: PathBuf,
    },
    MetricsSnapshot {
        metrics: MetricsSnapshot,
    },
}

#[derive(Clone, Debug, Default, Serialize, Deserialize)]
pub struct MetricsSnapshot {
    pub objects_discovered: u64,
    pub bytes_considered: u64,
    pub understood: u64,
    pub partial: u64,
    pub unknown: u64,
    pub failed: u64,
    pub entities: u64,
    pub relationships: u64,
    pub queue_depth: usize,
    pub elapsed_ms: u64,
}

impl PipelineEvent {
    pub fn summary(&self) -> String {
        match self {
            Self::ScanStarted { root } => format!("scan started: {}", root.display()),
            Self::ScanCompleted {
                objects,
                elapsed_ms,
            } => {
                format!("scan completed: {objects} objects in {elapsed_ms}ms")
            }
            Self::ObjectDiscovered { path, .. } => format!("discovered {}", path.display()),
            Self::ObjectQueued { id, queue_depth } => {
                format!("queued {id} (depth {queue_depth})")
            }
            Self::ProviderSelected {
                id,
                provider,
                support,
            } => {
                format!("provider {provider} for {id} ({support})")
            }
            Self::AnalysisStarted { id, provider } => {
                format!("analyzing {id} with {provider}")
            }
            Self::AnalysisCompleted {
                id,
                provider,
                status,
                entities,
                relationships,
            } => format!("analyzed {id} via {provider}: {status} (+{entities}e/{relationships}r)"),
            Self::EntityCreated { entity } => {
                format!("entity {} {}", entity.kind, entity.name)
            }
            Self::RelationshipCreated { kind, from, to } => {
                format!("rel {kind}: {from} -> {to}")
            }
            Self::ObjectClassified { id, status, reason } => {
                let r = reason.as_deref().unwrap_or("");
                format!("classified {id} as {status} {r}")
            }
            Self::Warning { message } => format!("warning: {message}"),
            Self::Failure { id, message } => match id {
                Some(id) => format!("failure {id}: {message}"),
                None => format!("failure: {message}"),
            },
            Self::ExportStarted { path } => format!("export started: {}", path.display()),
            Self::ExportCompleted { path } => format!("export completed: {}", path.display()),
            Self::MetricsSnapshot { metrics } => format!(
                "metrics: {} objs, {} understood, {} unknown",
                metrics.objects_discovered, metrics.understood, metrics.unknown
            ),
        }
    }
}