{"id":24297,"date":"2024-02-15T14:53:34","date_gmt":"2024-02-15T22:53:34","guid":{"rendered":"https:\/\/docs.extraview.com\/v25\/book\/evheartbeat-1\/"},"modified":"2025-02-17T10:35:36","modified_gmt":"2025-02-17T18:35:36","slug":"evheartbeat-1","status":"publish","type":"page","link":"https:\/\/docs.extraview.com\/v25\/extraview-25\/command-line-interface-1\/evheartbeat-1\/","title":{"rendered":"evheartbeat"},"content":{"rendered":"<p>This command checks the status of an ExtraView database, to indicate whether it is functioning correctly.<\/p>\n<h3>SYNOPSIS<\/h3>\n<p class=\"fixedWidthFont\">evheartbeat [-r] [-m]<\/p>\n<h3>DESCRIPTION<\/h3>\n<p>This command checks the status of several components of the ExtraView installation, and provides immediate feedback to the user. Additionally, this command is designed to send optional email output, so that a system administrator can be automatically notified if there is a system outage.<\/p>\n<p>The command may be configured with several entries in the <span class=\"fixedWidthFont\">evconfig.txt<\/span> file as shown in this example:<\/p>\n<p><code>HB_SMTP_SERVER = .com<br \/>\nHB_TO = you@&lt;your-domain&gt;.com[,your-buddy@&lt;your-domain&gt;.com]<br \/>\nHB_FROM = someone@thisplace.com <\/code><\/p>\n<ul>\n<li>The <span class=\"fixedWidthFont\">-r<\/span> option outputs the results from the command in raw XML format. Note: The XML returned also includes tags named DB_DATETIME, FREE_MEMORY, TOTAL_MEMORY, SERVICE_COUNT and HEARTBEAT_EXEC_TIME along with values. This information is useful if you are developing scripts that need to accurately know the current time of the server or scripts that monitor the performance of ExtraView running on the server. The time returned is the time on the database server. The memory statistics are in megabytes and the execution time is in milliseconds<\/li>\n<li>The <span class=\"fixedWidthFont\">-m<\/span> option signifies that email is to be sent when the command is run, and the command detects an error condition in the ExtraView installation. In this case, the above <span class=\"fixedWidthFont\">evconfig.txt<\/span> options must have been set. No email is sent if the ExtraView installation returns a success code. The intention is that <span class=\"fixedWidthFont\">evheartbeat -m<\/span> is used on a job, to monitor the health of the ExtraView installation. It is suggested that this script is run at least every 15 minutes throughout the day and night.<\/li>\n<\/ul>\n<p>If the configuration file has not been set correctly, then a message or warning is displayed on the screen, informing the user of the error.<\/p>\n<p>When sending email, evheartbeat places a header into the email message, entitled ExtraView-Audit.<\/p>\n<p>As the getHeartbeat call utilizes the API, care must be taken when the site is used with two factor authorization enabled via the ENABLE_TWO_FACTOR_AUTH behavior setting.\u00a0 The user account used to perform the request must be set to bypass 2FA, via its setting in the user account maintenance screen.\u00a0 This is required as there is no way in which an API call can enter the required second factor,<\/p>\n<p><code>ExtraView-Audit:<br \/>\nSent by system user &lt;login-name-of-sender&gt;,<br \/>\nfrom host &lt;name-of-host-running-evheartbeat&gt; (&lt;ip-address-of-host&gt;),<br \/>\non Tue Sep 30 17:04:17 2003, client program == evheartbeat.<\/code><\/p>\n<h3>EXAMPLE 1<\/h3>\n<p><code>$ evheartbeat<br \/>\nHeartbeat Results<br \/>\n-----------------<br \/>\nExtraView status : EXTRAVIEW ALIVE<br \/>\nDataBase status : DB CONNECTION CONFIRMED<br \/>\nDataBase Timestamp: 2004-10-11 22:15:09.000 -0700<br \/>\n$<\/code><\/p>\n<h3>EXAMPLE 2<\/h3>\n<p><code>$ evheartbeat -r<br \/>\n&lt;?xml version=\"1.0\" encoding=\"UTF-8\"?&gt;<br \/>\n&lt;EV_HEARTBEAT&gt;<br \/>\n&lt;EV_STATUS&gt;EXTRAVIEW ALIVE&lt;\/EV_STATUS&gt;<br \/>\n&lt;DB_STATUS&gt;DB CONNECTION CONFIRMED&lt;\/DB_STATUS&gt;<br \/>\n&lt;DB_DATETIME&gt;2004-10-11 22:15:22.000 -0700&lt;\/DB_DATETIME&gt;<br \/>\n&lt;FREE_MEMORY&gt;106&lt;\/FREE_MEMORY&gt;<br \/>\n&lt;TOTAL_MEMORY&gt;128&lt;\/TOTAL_MEMORY&gt;<br \/>\n&lt;SERVICE_COUNT&gt;1&lt;\/SERVICE_COUNT&gt;<br \/>\n&lt;HEARTBEAT_EXEC_TIME&gt;396&lt;\/HEARTBEAT_EXEC_TIME&gt;<br \/>\n&lt;\/EV_HEARTBEAT&gt;<br \/>\n$<\/code><\/p>\n","protected":false},"excerpt":{"rendered":"<p>This command checks the status of an ExtraView database, to indicate whether it is functioning correctly. SYNOPSIS evheartbeat [-r] [-m] DESCRIPTION This command checks the status of several components of the ExtraView installation, and provides immediate feedback to the user. Additionally, this command is designed to send optional email output, so that a system administrator&#8230;<\/p>\n","protected":false},"author":1,"featured_media":0,"parent":24277,"menu_order":35,"comment_status":"closed","ping_status":"closed","template":"","meta":{"_acf_changed":false,"_lmt_disableupdate":"no","_lmt_disable":"","_kad_blocks_custom_css":"","_kad_blocks_head_custom_js":"","_kad_blocks_body_custom_js":"","_kad_blocks_footer_custom_js":"","_kad_post_transparent":"","_kad_post_title":"","_kad_post_layout":"","_kad_post_sidebar_id":"","_kad_post_content_style":"","_kad_post_vertical_padding":"","_kad_post_feature":"","_kad_post_feature_position":"","_kad_post_header":false,"_kad_post_footer":false,"footnotes":""},"class_list":["post-24297","page","type-page","status-publish","hentry"],"acf":[],"yoast_head":"<!-- This site is optimized with the Yoast SEO plugin v25.1 - https:\/\/yoast.com\/wordpress\/plugins\/seo\/ -->\n<title>evheartbeat - Product Documentation<\/title>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/docs.extraview.com\/v25\/extraview-25\/command-line-interface-1\/evheartbeat-1\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"evheartbeat - Product Documentation\" \/>\n<meta property=\"og:description\" content=\"This command checks the status of an ExtraView database, to indicate whether it is functioning correctly. SYNOPSIS evheartbeat [-r] [-m] DESCRIPTION This command checks the status of several components of the ExtraView installation, and provides immediate feedback to the user. Additionally, this command is designed to send optional email output, so that a system administrator...\" \/>\n<meta property=\"og:url\" content=\"https:\/\/docs.extraview.com\/v25\/extraview-25\/command-line-interface-1\/evheartbeat-1\/\" \/>\n<meta property=\"og:site_name\" content=\"Product Documentation\" \/>\n<meta property=\"article:modified_time\" content=\"2025-02-17T18:35:36+00:00\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:label1\" content=\"Est. reading time\" \/>\n\t<meta name=\"twitter:data1\" content=\"3 minutes\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\/\/schema.org\",\"@graph\":[{\"@type\":\"WebPage\",\"@id\":\"https:\/\/docs.extraview.com\/v25\/extraview-25\/command-line-interface-1\/evheartbeat-1\/\",\"url\":\"https:\/\/docs.extraview.com\/v25\/extraview-25\/command-line-interface-1\/evheartbeat-1\/\",\"name\":\"evheartbeat - Product Documentation\",\"isPartOf\":{\"@id\":\"https:\/\/docs.extraview.com\/v25\/#website\"},\"datePublished\":\"2024-02-15T22:53:34+00:00\",\"dateModified\":\"2025-02-17T18:35:36+00:00\",\"breadcrumb\":{\"@id\":\"https:\/\/docs.extraview.com\/v25\/extraview-25\/command-line-interface-1\/evheartbeat-1\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/docs.extraview.com\/v25\/extraview-25\/command-line-interface-1\/evheartbeat-1\/\"]}]},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/docs.extraview.com\/v25\/extraview-25\/command-line-interface-1\/evheartbeat-1\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\/\/docs.extraview.com\/v25\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"ExtraView 25\",\"item\":\"https:\/\/docs.extraview.com\/v25\/\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Command Line Interface\",\"item\":\"https:\/\/docs.extraview.com\/v25\/extraview-25\/command-line-interface-1\/\"},{\"@type\":\"ListItem\",\"position\":4,\"name\":\"evheartbeat\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\/\/docs.extraview.com\/v25\/#website\",\"url\":\"https:\/\/docs.extraview.com\/v25\/\",\"name\":\"ExtraView Product Documentation\",\"description\":\"ExtraView Documentation\",\"publisher\":{\"@id\":\"https:\/\/docs.extraview.com\/v25\/#organization\"},\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\/\/docs.extraview.com\/v25\/?s={search_term_string}\"},\"query-input\":{\"@type\":\"PropertyValueSpecification\",\"valueRequired\":true,\"valueName\":\"search_term_string\"}}],\"inLanguage\":\"en-US\"},{\"@type\":\"Organization\",\"@id\":\"https:\/\/docs.extraview.com\/v25\/#organization\",\"name\":\"ExtraView Corporation\",\"url\":\"https:\/\/docs.extraview.com\/v25\/\",\"logo\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\/\/docs.extraview.com\/v25\/#\/schema\/logo\/image\/\",\"url\":\"https:\/\/docs-stg.extraview.com\/wp-content\/uploads\/2024\/03\/favicon.png\",\"contentUrl\":\"https:\/\/docs-stg.extraview.com\/wp-content\/uploads\/2024\/03\/favicon.png\",\"width\":512,\"height\":512,\"caption\":\"ExtraView Corporation\"},\"image\":{\"@id\":\"https:\/\/docs.extraview.com\/v25\/#\/schema\/logo\/image\/\"}}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","yoast_head_json":{"title":"evheartbeat - Product Documentation","robots":{"index":"index","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"canonical":"https:\/\/docs.extraview.com\/v25\/extraview-25\/command-line-interface-1\/evheartbeat-1\/","og_locale":"en_US","og_type":"article","og_title":"evheartbeat - Product Documentation","og_description":"This command checks the status of an ExtraView database, to indicate whether it is functioning correctly. SYNOPSIS evheartbeat [-r] [-m] DESCRIPTION This command checks the status of several components of the ExtraView installation, and provides immediate feedback to the user. Additionally, this command is designed to send optional email output, so that a system administrator...","og_url":"https:\/\/docs.extraview.com\/v25\/extraview-25\/command-line-interface-1\/evheartbeat-1\/","og_site_name":"Product Documentation","article_modified_time":"2025-02-17T18:35:36+00:00","twitter_card":"summary_large_image","twitter_misc":{"Est. reading time":"3 minutes"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"WebPage","@id":"https:\/\/docs.extraview.com\/v25\/extraview-25\/command-line-interface-1\/evheartbeat-1\/","url":"https:\/\/docs.extraview.com\/v25\/extraview-25\/command-line-interface-1\/evheartbeat-1\/","name":"evheartbeat - Product Documentation","isPartOf":{"@id":"https:\/\/docs.extraview.com\/v25\/#website"},"datePublished":"2024-02-15T22:53:34+00:00","dateModified":"2025-02-17T18:35:36+00:00","breadcrumb":{"@id":"https:\/\/docs.extraview.com\/v25\/extraview-25\/command-line-interface-1\/evheartbeat-1\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/docs.extraview.com\/v25\/extraview-25\/command-line-interface-1\/evheartbeat-1\/"]}]},{"@type":"BreadcrumbList","@id":"https:\/\/docs.extraview.com\/v25\/extraview-25\/command-line-interface-1\/evheartbeat-1\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/docs.extraview.com\/v25\/"},{"@type":"ListItem","position":2,"name":"ExtraView 25","item":"https:\/\/docs.extraview.com\/v25\/"},{"@type":"ListItem","position":3,"name":"Command Line Interface","item":"https:\/\/docs.extraview.com\/v25\/extraview-25\/command-line-interface-1\/"},{"@type":"ListItem","position":4,"name":"evheartbeat"}]},{"@type":"WebSite","@id":"https:\/\/docs.extraview.com\/v25\/#website","url":"https:\/\/docs.extraview.com\/v25\/","name":"ExtraView Product Documentation","description":"ExtraView Documentation","publisher":{"@id":"https:\/\/docs.extraview.com\/v25\/#organization"},"potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/docs.extraview.com\/v25\/?s={search_term_string}"},"query-input":{"@type":"PropertyValueSpecification","valueRequired":true,"valueName":"search_term_string"}}],"inLanguage":"en-US"},{"@type":"Organization","@id":"https:\/\/docs.extraview.com\/v25\/#organization","name":"ExtraView Corporation","url":"https:\/\/docs.extraview.com\/v25\/","logo":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/docs.extraview.com\/v25\/#\/schema\/logo\/image\/","url":"https:\/\/docs-stg.extraview.com\/wp-content\/uploads\/2024\/03\/favicon.png","contentUrl":"https:\/\/docs-stg.extraview.com\/wp-content\/uploads\/2024\/03\/favicon.png","width":512,"height":512,"caption":"ExtraView Corporation"},"image":{"@id":"https:\/\/docs.extraview.com\/v25\/#\/schema\/logo\/image\/"}}]}},"taxonomy_info":[],"featured_image_src_large":false,"author_info":{"display_name":"carl.koppel","author_link":"https:\/\/docs.extraview.com\/v25\/author\/carl-koppel\/"},"comment_info":0,"_links":{"self":[{"href":"https:\/\/docs.extraview.com\/v25\/wp-json\/wp\/v2\/pages\/24297","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/docs.extraview.com\/v25\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/docs.extraview.com\/v25\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/docs.extraview.com\/v25\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/docs.extraview.com\/v25\/wp-json\/wp\/v2\/comments?post=24297"}],"version-history":[{"count":0,"href":"https:\/\/docs.extraview.com\/v25\/wp-json\/wp\/v2\/pages\/24297\/revisions"}],"up":[{"embeddable":true,"href":"https:\/\/docs.extraview.com\/v25\/wp-json\/wp\/v2\/pages\/24277"}],"wp:attachment":[{"href":"https:\/\/docs.extraview.com\/v25\/wp-json\/wp\/v2\/media?parent=24297"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}