{"componentChunkName":"component---src-components-mark-down-block-js","path":"/docs/working-with/","result":{"data":{"markdownRemark":{"html":"<h2 id=\"working-with-appscope\" style=\"position:relative;\"><a href=\"#working-with-appscope\" aria-label=\"working with appscope permalink\" class=\"anchor before\"><svg aria-hidden=\"true\" focusable=\"false\" height=\"16\" version=\"1.1\" viewBox=\"0 0 16 16\" width=\"16\"><path fill-rule=\"evenodd\" d=\"M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z\"></path></svg></a>Working With AppScope</h2>\n<p>These docs explain two ways to work with AppScope: together with <a href=\"https://docs.cribl.io/edge/\">Cribl Edge</a>, and on its own. Cribl Edge provides a means to manage AppScope at scale. The concluding Reference topics generally apply for both approaches, although the <a href=\"/docs/cli-reference\">CLI Reference</a> is most relevant for using AppScope on its own or with other open-source tools.</p>\n<h3 id=\"using-appscope-with-cribl-edge\" style=\"position:relative;\"><a href=\"#using-appscope-with-cribl-edge\" aria-label=\"using appscope with cribl edge permalink\" class=\"anchor before\"><svg aria-hidden=\"true\" focusable=\"false\" height=\"16\" version=\"1.1\" viewBox=\"0 0 16 16\" width=\"16\"><path fill-rule=\"evenodd\" d=\"M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z\"></path></svg></a>Using AppScope with Cribl Edge</h3>\n<p>Here we'll cover working on a Linux host or virtual machine, in a Docker or similar container, or on Kubernetes.</p>\n<p>These topics are complementary to Cribl's documentation about the <a href=\"https://docs.cribl.io/stream/sources-appscope\">AppScope Source</a> and the <a href=\"https://docs.cribl.io/stream/4.0/appscope-configs\">AppScope Config Editor</a>.</p>\n<p>AppScope comes bundled with Cribl Edge, so there's no need to discuss how to obtain AppScope. </p>\n<h3 id=\"using-appscope-on-its-own\" style=\"position:relative;\"><a href=\"#using-appscope-on-its-own\" aria-label=\"using appscope on its own permalink\" class=\"anchor before\"><svg aria-hidden=\"true\" focusable=\"false\" height=\"16\" version=\"1.1\" viewBox=\"0 0 16 16\" width=\"16\"><path fill-rule=\"evenodd\" d=\"M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z\"></path></svg></a>Using AppScope On its Own</h3>\n<p>Here we'll cover obtaining, and then using AppScope, starting with the CLI.</p>\n<h2 id=\"fundamentals\" style=\"position:relative;\"><a href=\"#fundamentals\" aria-label=\"fundamentals permalink\" class=\"anchor before\"><svg aria-hidden=\"true\" focusable=\"false\" height=\"16\" version=\"1.1\" viewBox=\"0 0 16 16\" width=\"16\"><path fill-rule=\"evenodd\" d=\"M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z\"></path></svg></a>Fundamental Concepts</h2>\n<p>To work effectively with AppScope, start with these fundamental points:</p>\n<ul>\n<li>Your overall approach can be either spontaneous or more planned-out.</li>\n<li>You can <a href=\"#config-file-etc\">control</a> AppScope by means of the config file, environment variables, or a combination of the two.</li>\n<li>The results you get from AppScope will be in the form of <a href=\"/docs/events-and-metrics\">events and metrics</a>. When you scope HTTP applications, you can get payloads, too.</li>\n</ul>\n<h2 id=\"pid-vs-rule\" style=\"position:relative;\"><a href=\"#pid-vs-rule\" aria-label=\"pid vs rule permalink\" class=\"anchor before\"><svg aria-hidden=\"true\" focusable=\"false\" height=\"16\" version=\"1.1\" viewBox=\"0 0 16 16\" width=\"16\"><path fill-rule=\"evenodd\" d=\"M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z\"></path></svg></a>Scoping By PID and Scoping By Rule</h2>\n<p>Another important distinction to understand when working with AppScope is that between \"scope by PID\" and \"scope by Rule.\"</p>\n<ul>\n<li>Scope by PID instruments one process on one host or container.</li>\n<li>\n<p>Scope by Rule instruments one or more processes, not only on one host, but, when using AppScope together with Cribl Edge, an entire Edge Fleet.</p>\n<ul>\n<li>The principle is that AppScope will instrument whatever processes match a given Rule.</li>\n</ul>\n</li>\n</ul>\n<h2 id=\"config-file-etc\" style=\"position:relative;\"><a href=\"#config-file-etc\" aria-label=\"config file etc permalink\" class=\"anchor before\"><svg aria-hidden=\"true\" focusable=\"false\" height=\"16\" version=\"1.1\" viewBox=\"0 0 16 16\" width=\"16\"><path fill-rule=\"evenodd\" d=\"M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z\"></path></svg></a>The Config File, Env Vars, and Flags</h2>\n<p>AppScope's ease of use stems from its flexible set of controls:</p>\n<ul>\n<li>AppScope's configuration file, <code>scope.yml</code>, can be invoked from either the CLI or the library.</li>\n<li>The AppScope library provides an extensive set of environment variables, which control settings like metric verbosity and event destinations. Environment variables override config file settings.</li>\n</ul>\n<p>Check out the <a href=\"/docs/cli-using\">CLI</a> and <a href=\"/docs/library-using\">library</a> pages to see how it's done.</p>","frontmatter":{"title":"Working With AppScope"}}},"pageContext":{"slug":"/working-with/","id":"745b7d15-845e-5453-98a7-e68b6754cf86"}},"staticQueryHashes":["2787008656","306729481","625673991","640077088"]}