2016-03-04 15:15:51 +00:00
<!DOCTYPE html>
<!-- [if IE 8]><html class="no - js lt - ie9" lang="en" > <![endif] -->
<!-- [if gt IE 8]><! --> < html class = "no-js" lang = "en" > <!-- <![endif] -->
< head >
< meta charset = "utf-8" >
< meta name = "viewport" content = "width=device-width, initial-scale=1.0" >
2016-05-09 16:13:23 +00:00
< title > Node administration — R3 Corda latest documentation< / title >
2016-03-04 15:15:51 +00:00
< link rel = "stylesheet" href = "_static/css/custom.css" type = "text/css" / >
2016-05-09 16:13:23 +00:00
< link rel = "top" title = "R3 Corda latest documentation" href = "index.html" / >
2016-09-23 09:55:23 +00:00
< link rel = "next" title = "The Corda Configuration File" href = "corda-configuration-files.html" / >
2016-05-09 16:13:23 +00:00
< link rel = "prev" title = "Running the demos" href = "running-the-demos.html" / >
2016-03-04 15:15:51 +00:00
2016-05-09 16:13:23 +00:00
< script src = "_static/js/modernizr.min.js" > < / script >
2016-03-04 15:15:51 +00:00
< / head >
< body class = "wy-body-for-nav" role = "document" >
< div class = "wy-grid-for-nav" >
< nav data-toggle = "wy-nav-shift" class = "wy-nav-side" >
< div class = "wy-side-scroll" >
< div class = "wy-side-nav-search" >
2016-03-08 17:30:51 +00:00
2016-03-04 15:15:51 +00:00
2016-05-09 16:13:23 +00:00
< a href = "index.html" class = "icon icon-home" > R3 Corda
2016-03-04 15:15:51 +00:00
< / a >
< div class = "version" >
latest
< / div >
< div role = "search" >
< form id = "rtd-search-form" class = "wy-form" action = "search.html" method = "get" >
< input type = "text" name = "q" placeholder = "Search docs" / >
< input type = "hidden" name = "check_keywords" value = "yes" / >
< input type = "hidden" name = "area" value = "default" / >
< / form >
< / div >
2016-03-08 17:30:51 +00:00
< br >
< a href = "api/index.html" > API reference< / a >
2016-03-04 15:15:51 +00:00
< / div >
< div class = "wy-menu wy-menu-vertical" data-spy = "affix" role = "navigation" aria-label = "main navigation" >
< p class = "caption" > < span class = "caption-text" > Overview< / span > < / p >
< ul class = "current" >
< li class = "toctree-l1" > < a class = "reference internal" href = "inthebox.html" > What’ s included?< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "getting-set-up.html" > Getting set up< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "data-model.html" > Data model< / a > < / li >
2016-06-30 12:49:28 +00:00
< li class = "toctree-l1" > < a class = "reference internal" href = "transaction-data-types.html" > Data types< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "consensus.html" > Consensus model< / a > < / li >
2016-03-04 15:15:51 +00:00
< li class = "toctree-l1" > < a class = "reference internal" href = "messaging.html" > Networking and messaging< / a > < / li >
2016-10-11 09:30:55 +00:00
< li class = "toctree-l1" > < a class = "reference internal" href = "persistence.html" > Persistence< / a > < / li >
2016-08-30 11:05:32 +00:00
< li class = "toctree-l1" > < a class = "reference internal" href = "creating-a-cordapp.html" > Creating a Cordapp< / a > < / li >
2016-05-09 16:13:23 +00:00
< li class = "toctree-l1" > < a class = "reference internal" href = "running-the-demos.html" > Running the demos< / a > < / li >
2016-04-13 09:29:54 +00:00
< li class = "toctree-l1 current" > < a class = "current reference internal" href = "#" > Node administration< / a > < ul >
2016-10-11 09:30:55 +00:00
< li class = "toctree-l2" > < a class = "reference internal" href = "#database-access" > Database access< / a > < / li >
2016-03-15 16:13:01 +00:00
< li class = "toctree-l2" > < a class = "reference internal" href = "#monitoring-your-node" > Monitoring your node< / a > < / li >
2016-03-04 15:15:51 +00:00
< li class = "toctree-l2" > < a class = "reference internal" href = "#uploading-and-downloading-attachments" > Uploading and downloading attachments< / a > < / li >
2016-03-15 16:13:01 +00:00
< li class = "toctree-l2" > < a class = "reference internal" href = "#uploading-interest-rate-fixes" > Uploading interest rate fixes< / a > < / li >
2016-03-04 15:15:51 +00:00
< / ul >
< / li >
2016-09-23 09:55:23 +00:00
< li class = "toctree-l1" > < a class = "reference internal" href = "corda-configuration-files.html" > The Corda Configuration File< / a > < / li >
2016-03-04 15:15:51 +00:00
< / ul >
< p class = "caption" > < span class = "caption-text" > Tutorials< / span > < / p >
< ul >
2016-05-24 11:27:23 +00:00
< li class = "toctree-l1" > < a class = "reference internal" href = "where-to-start.html" > Where to start< / a > < / li >
2016-05-23 16:05:37 +00:00
< li class = "toctree-l1" > < a class = "reference internal" href = "tutorial-contract.html" > Writing a contract< / a > < / li >
2016-07-12 16:52:52 +00:00
< li class = "toctree-l1" > < a class = "reference internal" href = "tutorial-contract-clauses.html" > Writing a contract using clauses< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "tutorial-test-dsl.html" > Writing a contract test< / a > < / li >
2016-10-11 09:30:55 +00:00
< li class = "toctree-l1" > < a class = "reference internal" href = "tutorial-clientrpc-api.html" > Client RPC API< / a > < / li >
2016-03-04 15:15:51 +00:00
< li class = "toctree-l1" > < a class = "reference internal" href = "protocol-state-machines.html" > Protocol state machines< / a > < / li >
2016-03-15 16:13:01 +00:00
< li class = "toctree-l1" > < a class = "reference internal" href = "oracles.html" > Writing oracle services< / a > < / li >
2016-10-11 09:30:55 +00:00
< li class = "toctree-l1" > < a class = "reference internal" href = "tutorial-attachments.html" > Using attachments< / a > < / li >
2016-06-30 12:49:28 +00:00
< li class = "toctree-l1" > < a class = "reference internal" href = "event-scheduling.html" > Event scheduling< / a > < / li >
2016-09-23 09:55:23 +00:00
< li class = "toctree-l1" > < a class = "reference internal" href = "secure-coding-guidelines.html" > Secure coding guidelines< / a > < / li >
< / ul >
< p class = "caption" > < span class = "caption-text" > Contracts< / span > < / p >
< ul >
< li class = "toctree-l1" > < a class = "reference internal" href = "contract-catalogue.html" > Contract catalogue< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "contract-irs.html" > Interest Rate Swaps< / a > < / li >
< / ul >
< p class = "caption" > < span class = "caption-text" > Node API< / span > < / p >
< ul >
< li class = "toctree-l1" > < a class = "reference internal" href = "clientrpc.html" > Client RPC< / a > < / li >
2016-03-04 15:15:51 +00:00
< / ul >
< p class = "caption" > < span class = "caption-text" > Appendix< / span > < / p >
< ul >
2016-05-23 16:05:37 +00:00
< li class = "toctree-l1" > < a class = "reference internal" href = "release-process.html" > Release process< / a > < / li >
2016-06-13 17:27:53 +00:00
< li class = "toctree-l1" > < a class = "reference internal" href = "release-process.html#steps-to-cut-a-release" > Steps to cut a release< / a > < / li >
2016-05-24 11:27:23 +00:00
< li class = "toctree-l1" > < a class = "reference internal" href = "release-notes.html" > Release notes< / a > < / li >
2016-09-23 09:55:23 +00:00
< li class = "toctree-l1" > < a class = "reference internal" href = "network-simulator.html" > Network Simulator< / a > < / li >
2016-03-04 15:15:51 +00:00
< li class = "toctree-l1" > < a class = "reference internal" href = "codestyle.html" > Code style guide< / a > < / li >
2016-05-09 16:13:23 +00:00
< li class = "toctree-l1" > < a class = "reference internal" href = "building-the-docs.html" > Building the documentation< / a > < / li >
2016-03-04 15:15:51 +00:00
< / ul >
< / div >
< / div >
< / nav >
< section data-toggle = "wy-nav-shift" class = "wy-nav-content-wrap" >
< nav class = "wy-nav-top" role = "navigation" aria-label = "top navigation" >
< i data-toggle = "wy-nav-top" class = "fa fa-bars" > < / i >
2016-05-09 16:13:23 +00:00
< a href = "index.html" > R3 Corda< / a >
2016-03-04 15:15:51 +00:00
< / nav >
< div class = "wy-nav-content" >
< div class = "rst-content" >
2016-04-13 09:29:54 +00:00
2016-03-04 15:15:51 +00:00
< div role = "navigation" aria-label = "breadcrumbs navigation" >
< ul class = "wy-breadcrumbs" >
< li > < a href = "index.html" > Docs< / a > » < / li >
< li > Node administration< / li >
< li class = "wy-breadcrumbs-aside" >
< a href = "_sources/node-administration.txt" rel = "nofollow" > View page source< / a >
< / li >
< / ul >
< hr / >
< / div >
< div role = "main" class = "document" itemscope = "itemscope" itemtype = "http://schema.org/Article" >
< div itemprop = "articleBody" >
< div class = "section" id = "node-administration" >
< h1 > Node administration< a class = "headerlink" href = "#node-administration" title = "Permalink to this headline" > ¶< / a > < / h1 >
2016-10-11 09:30:55 +00:00
< p > When a node is running, it exposes an embedded database server, an embedded web server that lets you monitor it,
you can upload and download attachments, access a REST API and so on.< / p >
< div class = "section" id = "database-access" >
< h2 > Database access< a class = "headerlink" href = "#database-access" title = "Permalink to this headline" > ¶< / a > < / h2 >
< p > The node exposes its internal database over a socket which can be browsed using any tool that can use JDBC drivers.
The JDBC URL is printed during node startup to the log and will typically look like this:< / p >
< blockquote >
< div > < code class = "docutils literal" > < span class = "pre" > jdbc:h2:tcp://192.168.0.31:31339/node< / span > < / code > < / div > < / blockquote >
< p > The username and password can be altered in the < span class = "xref doc" > corda-config-files< / span > but default to username “ sa” and a blank
password.< / p >
< p > Any database browsing tool that supports JDBC can be used, but if you have IntelliJ Ultimate edition then there is
a tool integrated with your IDE. Just open the database window and add an H2 data source with the above details.
You will now be able to browse the tables and row data within them.< / p >
< / div >
2016-03-15 16:13:01 +00:00
< div class = "section" id = "monitoring-your-node" >
< h2 > Monitoring your node< a class = "headerlink" href = "#monitoring-your-node" title = "Permalink to this headline" > ¶< / a > < / h2 >
< p > Like most Java servers, the node exports various useful metrics and management operations via the industry-standard
2016-05-23 16:05:37 +00:00
< a class = "reference external" href = "https://en.wikipedia.org/wiki/Java_Management_Extensions" > JMX infrastructure< / a > . JMX is a standard API
2016-08-30 11:05:32 +00:00
for registering so-called < em > MBeans< / em > ... objects whose properties and methods are intended for server management. It does
2016-03-15 16:13:01 +00:00
not require any particular network protocol for export. So this data can be exported from the node in various ways:
some monitoring systems provide a “ Java Agent” , which is essentially a JVM plugin that finds all the MBeans and sends
them out to a statistics collector over the network. For those systems, follow the instructions provided by the vendor.< / p >
< p > Sometimes though, you just want raw access to the data and operations itself. So nodes export them over HTTP on the
2016-10-11 09:30:55 +00:00
< code class = "docutils literal" > < span class = "pre" > /monitoring/json< / span > < / code > HTTP endpoint, using a program called < a class = "reference external" href = "https://jolokia.org/" > Jolokia< / a > . Jolokia defines the JSON
2016-03-15 16:13:01 +00:00
and REST formats for accessing MBeans, and provides client libraries to work with that protocol as well.< / p >
< p > Here are a few ways to build dashboards and extract monitoring data for a node:< / p >
< ul class = "simple" >
< li > < a class = "reference external" href = "https://github.com/logzio/jmx2graphite" > JMX2Graphite< / a > is a tool that can be pointed to /monitoring/json and will
scrape the statistics found there, then insert them into the Graphite monitoring tool on a regular basis. It runs
in Docker and can be started with a single command.< / li >
< li > < a class = "reference external" href = "https://github.com/jmxtrans/jmxtrans" > JMXTrans< / a > is another tool for Graphite, this time, it’ s got its own agent
(JVM plugin) which reads a custom config file and exports only the named data. It’ s more configurable than
JMX2Graphite and doesn’ t require a separate process, as the JVM will write directly to Graphite.< / li >
< li > < em > Java Mission Control< / em > is a desktop app that can connect to a target JVM that has the right command line flags set
(or always, if running locally). You can explore what data is available, create graphs of those metrics, and invoke
management operations like forcing a garbage collection.< / li >
< li > Cloud metrics services like New Relic also understand JMX, typically, by providing their own agent that uploads the
data to their service on a regular schedule.< / li >
< / ul >
< / div >
2016-03-04 15:15:51 +00:00
< div class = "section" id = "uploading-and-downloading-attachments" >
< h2 > Uploading and downloading attachments< a class = "headerlink" href = "#uploading-and-downloading-attachments" title = "Permalink to this headline" > ¶< / a > < / h2 >
< p > Attachments are files that add context to and influence the behaviour of transactions. They are always identified by
hash and they are public, in that they propagate through the network to wherever they are needed.< / p >
< p > All attachments are zip files. Thus to upload a file to the ledger you must first wrap it into a zip (or jar) file. Then
you can upload it by running this command from a UNIX terminal:< / p >
2016-04-13 09:29:54 +00:00
< div class = "highlight-shell" > < div class = "highlight" > < pre > < span > < / span > curl -F < span class = "nv" > myfile< / span > < span class = "o" > =< / span > @path/to/my/file.zip http://localhost:31338/upload/attachment
2016-03-04 15:15:51 +00:00
< / pre > < / div >
< / div >
< p > The attachment will be identified by the SHA-256 hash of the contents, which you can get by doing:< / p >
2016-04-13 09:29:54 +00:00
< div class = "highlight-shell" > < div class = "highlight" > < pre > < span > < / span > shasum -a < span class = "m" > 256< / span > file.zip
2016-03-04 15:15:51 +00:00
< / pre > < / div >
< / div >
2016-03-15 16:13:01 +00:00
< p > on a Mac or by using < code class = "docutils literal" > < span class = "pre" > sha256sum< / span > < / code > on Linux. Alternatively, the hash will be returned to you when you upload the
attachment.< / p >
2016-03-04 15:15:51 +00:00
< p > An attachment may be downloaded by fetching:< / p >
2016-04-13 09:29:54 +00:00
< div class = "highlight-shell" > < div class = "highlight" > < pre > < span > < / span > http://localhost:31338/attachments/DECD098666B9657314870E192CED0C3519C2C9D395507A238338F8D003929DE9
2016-03-04 15:15:51 +00:00
< / pre > < / div >
< / div >
< p > where DECD... is of course replaced with the hash identifier of your own attachment. Because attachments are always
containers, you can also fetch a specific file within the attachment by appending its path, like this:< / p >
2016-04-13 09:29:54 +00:00
< div class = "highlight-shell" > < div class = "highlight" > < pre > < span > < / span > http://localhost:31338/attachments/DECD098666B9657314870E192CED0C3519C2C9D395507A238338F8D003929DE9/path/within/zip.txt
2016-03-04 15:15:51 +00:00
< / pre > < / div >
< / div >
< / div >
2016-03-15 16:13:01 +00:00
< div class = "section" id = "uploading-interest-rate-fixes" >
< h2 > Uploading interest rate fixes< a class = "headerlink" href = "#uploading-interest-rate-fixes" title = "Permalink to this headline" > ¶< / a > < / h2 >
< p > If you would like to operate an interest rate fixing service (oracle), you can upload fix data by uploading data in
a simple text format to the < code class = "docutils literal" > < span class = "pre" > /upload/interest-rates< / span > < / code > path on the web server.< / p >
< p > The file looks like this:< / p >
2016-04-13 09:29:54 +00:00
< div class = "highlight-kotlin" > < div class = "highlight" > < pre > < span > < / span > # Some pretend noddy rate fixes, for the interest rate oracles.
2016-03-15 16:13:01 +00:00
2016-04-13 09:29:54 +00:00
LIBOR 2016-03-16 1M = 0.678
LIBOR 2016-03-16 2M = 0.655
EURIBOR 2016-03-15 1M = 0.123
EURIBOR 2016-03-15 2M = 0.111
2016-03-15 16:13:01 +00:00
< / pre > < / div >
< / div >
< p > The columns are:< / p >
< ul class = "simple" >
< li > Name of the fix< / li >
< li > Date of the fix< / li >
< li > The tenor / time to maturity in days< / li >
< li > The interest rate itself< / li >
< / ul >
< / div >
2016-03-04 15:15:51 +00:00
< / div >
< / div >
< / div >
< footer >
< div class = "rst-footer-buttons" role = "navigation" aria-label = "footer navigation" >
2016-09-23 09:55:23 +00:00
< a href = "corda-configuration-files.html" class = "btn btn-neutral float-right" title = "The Corda Configuration File" accesskey = "n" > Next < span class = "fa fa-arrow-circle-right" > < / span > < / a >
2016-05-09 16:13:23 +00:00
< a href = "running-the-demos.html" class = "btn btn-neutral" title = "Running the demos" accesskey = "p" > < span class = "fa fa-arrow-circle-left" > < / span > Previous< / a >
2016-03-04 15:15:51 +00:00
< / div >
< hr / >
< div role = "contentinfo" >
< p >
2016-05-09 16:13:23 +00:00
© Copyright 2016, Distributed Ledger Group, LLC.
2016-03-04 15:15:51 +00:00
< / p >
< / div >
Built with < a href = "http://sphinx-doc.org/" > Sphinx< / a > using a < a href = "https://github.com/snide/sphinx_rtd_theme" > theme< / a > provided by < a href = "https://readthedocs.org" > Read the Docs< / a > .
< / footer >
< / div >
< / div >
< / section >
< / div >
< script type = "text/javascript" >
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
VERSION:'latest',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true
};
< / script >
< script type = "text/javascript" src = "_static/jquery.js" > < / script >
< script type = "text/javascript" src = "_static/underscore.js" > < / script >
< script type = "text/javascript" src = "_static/doctools.js" > < / script >
< script type = "text/javascript" src = "_static/js/theme.js" > < / script >
< script type = "text/javascript" >
jQuery(function () {
SphinxRtdTheme.StickyNav.enable();
});
< / script >
< / body >
< / html >
