solace-agent-mesh 0.2.3__py3-none-any.whl → 1.0.1__py3-none-any.whl

solace_agent_mesh/assets/docs/assets/js/fbfa3e75.aca209c9.js

@@ -0,0 +1 @@
+"use strict";(self.webpackChunksolace_agenitc_mesh_docs=self.webpackChunksolace_agenitc_mesh_docs||[]).push([[2424],{2998:(e,s,i)=>{i.r(s),i.d(s,{assets:()=>a,contentTitle:()=>l,default:()=>h,frontMatter:()=>r,metadata:()=>n,toc:()=>c});const n=JSON.parse('{"id":"documentation/deployment/observability","title":"Observability","description":"Solace Agent Mesh provides a comprehensive set of tools for real-time system monitoring and key insights to help you understand system states, request flows, and key insights for debugging and optimizing your system.","source":"@site/docs/documentation/deployment/observability.md","sourceDirName":"documentation/deployment","slug":"/documentation/deployment/observability","permalink":"/solace-agent-mesh/docs/documentation/deployment/observability","draft":false,"unlisted":false,"editUrl":"https://github.com/SolaceLabs/solace-agent-mesh/edit/main/docs/docs/documentation/deployment/observability.md","tags":[],"version":"current","sidebarPosition":20,"frontMatter":{"title":"Observability","sidebar_position":20},"sidebar":"docSidebar","previous":{"title":"Deployment","permalink":"/solace-agent-mesh/docs/documentation/deployment/deploy"},"next":{"title":"Debugging","permalink":"/solace-agent-mesh/docs/documentation/deployment/debugging"}}');var t=i(4848),o=i(8453);const r={title:"Observability",sidebar_position:20},l="Observability",a={},c=[{value:"Workflow Viewer",id:"workflow-viewer",level:2},{value:"Agents View",id:"agents-view",level:2},{value:"Broker Observability",id:"broker-observability",level:2},{value:"Stimulus Logs",id:"stimulus-logs",level:2}];function d(e){const s={a:"a",admonition:"admonition",code:"code",em:"em",h1:"h1",h2:"h2",header:"header",li:"li",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,o.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(s.header,{children:(0,t.jsx)(s.h1,{id:"observability",children:"Observability"})}),"\n",(0,t.jsx)(s.p,{children:"Solace Agent Mesh provides a comprehensive set of tools for real-time system monitoring and key insights to help you understand system states, request flows, and key insights for debugging and optimizing your system."}),"\n",(0,t.jsx)(s.h2,{id:"workflow-viewer",children:"Workflow Viewer"}),"\n",(0,t.jsx)(s.p,{children:"The Solace Agent Mesh web UI includes a built-in workflow viewer, which provides an interactive web-based UI for each user query and its corresponding response. This visualizer allows you to:"}),"\n",(0,t.jsxs)(s.ul,{children:["\n",(0,t.jsx)(s.li,{children:"Track the complete life cycle of a stimulus (request) as it moves through the system."}),"\n",(0,t.jsx)(s.li,{children:"Visualize the flow of requests/responses among agents, the user gateway and LLM."}),"\n",(0,t.jsx)(s.li,{children:"Monitor all participating agents and their activity in real-time."}),"\n"]}),"\n",(0,t.jsxs)(s.p,{children:["To launch the workflow viewer for a specific query/response pair, click the ",(0,t.jsx)(s.strong,{children:"View Agent Workflow"})," icon located at the bottom left of the final response. The complete workflow chart appears in the side panel on the right."]}),"\n",(0,t.jsx)(s.h2,{id:"agents-view",children:"Agents View"}),"\n",(0,t.jsxs)(s.p,{children:["The Solace Agent Mesh web UI also includes an ",(0,t.jsx)(s.strong,{children:"Agents"})," view, which provides a comprehensive overview of all registered agents in the system in real-time. This view allows you to:"]}),"\n",(0,t.jsxs)(s.ul,{children:["\n",(0,t.jsx)(s.li,{children:"See all agents currently registered in the system."}),"\n",(0,t.jsx)(s.li,{children:"View agents description, capabilities, and skills"}),"\n",(0,t.jsx)(s.li,{children:"View agent hierarchical topology and relationships."}),"\n"]}),"\n",(0,t.jsxs)(s.p,{children:["To access the Agents view, open the web interface in your browser and switch to the ",(0,t.jsx)(s.strong,{children:"Agents"})," tab."]}),"\n",(0,t.jsx)(s.h2,{id:"broker-observability",children:"Broker Observability"}),"\n",(0,t.jsx)(s.p,{children:"Solace Agent Mesh relies on a PubSub+ event broker for all its communication. Various tools are available to monitor the event broker\u2019s activity and message flows:"}),"\n",(0,t.jsxs)(s.ul,{children:["\n",(0,t.jsxs)(s.li,{children:[(0,t.jsx)(s.strong,{children:"PubSub+ Broker Manager"})," \u2013 A web-based interface where you can use the ",(0,t.jsx)(s.em,{children:"Try Me!"})," tab to send and receive messages interactively."]}),"\n",(0,t.jsxs)(s.li,{children:[(0,t.jsx)(s.strong,{children:(0,t.jsx)(s.a,{href:"https://marketplace.visualstudio.com/items?itemName=solace-tools.solace-try-me-vsc-extension",children:"Solace Try Me VSCode Extension"})})," \u2013 A convenient way to test message flows within Visual Studio Code."]}),"\n",(0,t.jsxs)(s.li,{children:[(0,t.jsx)(s.strong,{children:(0,t.jsx)(s.a,{href:"https://github.com/SolaceLabs/solace-tryme-cli",children:"Solace Try Me (STM) CLI Tool"})})," \u2013 A command-line tool for sending and receiving messages."]}),"\n"]}),"\n",(0,t.jsx)(s.p,{children:"To observe all message flows within the event broker, subscribe to the following topic:"}),"\n",(0,t.jsx)(s.pre,{children:(0,t.jsx)(s.code,{children:"[NAME_SPACES]a2a/v1/>\n"})}),"\n",(0,t.jsxs)(s.p,{children:["Replace ",(0,t.jsx)(s.code,{children:"[NAME_SPACES]"})," with the namespace you are using. If none, omit the ",(0,t.jsx)(s.code,{children:"[NAME_SPACES]"})," part."]}),"\n",(0,t.jsxs)(s.admonition,{type:"tip",children:[(0,t.jsx)(s.p,{children:"Agents periodically send registration messages, which may clutter your UI if you're using the STM VSCode extension. To filter out these messages, you can add the following topic to the ignore list:"}),(0,t.jsx)(s.pre,{children:(0,t.jsx)(s.code,{children:"[NAME_SPACES]/a2a/v1/discovery/agentcards\n"})})]}),"\n",(0,t.jsx)(s.h2,{id:"stimulus-logs",children:"Stimulus Logs"}),"\n",(0,t.jsxs)(s.p,{children:["Solace Agent Mesh includes a default monitor that records each request (stimulus) life cycle. These logs are stored as ",(0,t.jsx)(s.code,{children:".stim"})," files."]}),"\n",(0,t.jsxs)(s.p,{children:["Each ",(0,t.jsx)(s.code,{children:".stim"})," file captures a complete trace of a stimulus, including:"]}),"\n",(0,t.jsxs)(s.ul,{children:["\n",(0,t.jsx)(s.li,{children:"Every component it passed through."}),"\n",(0,t.jsx)(s.li,{children:"Timing and sequencing details."}),"\n",(0,t.jsx)(s.li,{children:"Additional contextual metadata."}),"\n"]}),"\n",(0,t.jsx)(s.p,{children:"These logs provide a valuable data source for further visualization, troubleshooting, and performance analysis."}),"\n",(0,t.jsxs)(s.p,{children:["By default, ",(0,t.jsx)(s.code,{children:".stim"})," files are written to the ",(0,t.jsx)(s.code,{children:"/tmp/solace-agent-mesh/"})," directory."]})]})}function h(e={}){const{wrapper:s}={...(0,o.R)(),...e.components};return s?(0,t.jsx)(s,{...e,children:(0,t.jsx)(d,{...e})}):d(e)}},8453:(e,s,i)=>{i.d(s,{R:()=>r,x:()=>l});var n=i(6540);const t={},o=n.createContext(t);function r(e){const s=n.useContext(o);return n.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function l(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:r(e.components),n.createElement(o.Provider,{value:s},e.children)}}}]);