{"type":"doc","content":[{"type":"extension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"toc","parameters":{"macroParams":{"maxLevel":{"value":"2"},"type":{"value":"flat"}},"macroMetadata":{"macroId":{"value":"6a48c8de-7a65-4def-b080-fa1897dafbc6"},"schemaVersion":{"value":"1"},"title":"Table of Contents"}},"localId":"727e5026-b439-4057-80bf-c80e6ee601f1"}},{"type":"paragraph","content":[{"text":"Tokens are employed to authorize the event sources that send data to Devo over HTTP. Generate a token for your HTTP endpoint in the Devo web application, then use that token to set up event sending from your HTTP endpoint.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Create the token needed to authorize the endpoint","type":"text"}]},{"type":"paragraph","content":[{"text":"The OAuth token is a 32-character alphanumeric string that authorizes a connection to Devo. When this token is used when making HTTP requests to Devo, it is recognized by the platform and the connection is authorized and the request carried out. To create the token:","type":"text"}]},{"type":"bodiedExtension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"rw-ui-steps-macro","parameters":{"macroParams":{},"macroMetadata":{"macroId":{"value":"ad109085-e510-441a-9913-28e39eda0e7d"},"schemaVersion":{"value":"1"},"placeholder":[{"type":"icon","data":{"url":"https://d1bgdtsfe1sjdg.cloudfront.net/refinedtheme-for-cloud/macro-icons/steps.png"}}],"title":"UI Steps"}},"localId":"9b98ed8c-b81c-41a7-862d-6581ad546fc8"},"content":[{"type":"extension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"rw-step","parameters":{"macroParams":{},"macroMetadata":{"macroId":{"value":"9217f8f7-7058-4310-9033-75210f8fcdf6"},"schemaVersion":{"value":"1"},"placeholder":[{"type":"icon","data":{"url":"https://d1bgdtsfe1sjdg.cloudfront.net/refinedtheme-for-cloud/macro-icons/step.png"}}],"title":"UI Step"}},"localId":"053a332a-9d70-45fb-ad30-810ed7700b16"}},{"type":"paragraph","content":[{"text":"Go to ","type":"text"},{"text":"Administration → Credentials","type":"text","marks":[{"type":"strong"}]},{"text":" and select the ","type":"text"},{"text":"Authentication Tokens","type":"text","marks":[{"type":"strong"}]},{"text":" tab.","type":"text"}]},{"type":"extension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"rw-step","parameters":{"macroParams":{},"macroMetadata":{"macroId":{"value":"4057fc78-deaa-4b0e-96af-3ae6b6a70cf1"},"schemaVersion":{"value":"1"},"placeholder":[{"type":"icon","data":{"url":"https://d1bgdtsfe1sjdg.cloudfront.net/refinedtheme-for-cloud/macro-icons/step.png"}}],"title":"UI Step"}},"localId":"f06b99e4-d1ef-440b-8cb6-37be2abf6434"}},{"type":"paragraph","content":[{"text":"Click ","type":"text"},{"text":"New Token","type":"text","marks":[{"type":"strong"}]},{"text":".","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"center"},"content":[{"type":"media","attrs":{"width":681,"id":"9659efeb-49d4-41e3-9cfb-d307729349f6","collection":"contentId-94641061","type":"file","height":305}}]},{"type":"extension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"rw-step","parameters":{"macroParams":{},"macroMetadata":{"macroId":{"value":"5ccbcb1e-9131-4bc4-83a9-ace1ae077553"},"schemaVersion":{"value":"1"},"placeholder":[{"type":"icon","data":{"url":"https://d1bgdtsfe1sjdg.cloudfront.net/refinedtheme-for-cloud/macro-icons/step.png"}}],"title":"UI Step"}},"localId":"ddf2e61d-9ab7-467b-ad36-009c6e0d0728"}},{"type":"paragraph","content":[{"text":"Enter a descriptive ","type":"text"},{"text":"Name ","type":"text","marks":[{"type":"strong"}]},{"text":"and choose the person that will use the token in the ","type":"text"},{"text":"Authorized user ","type":"text","marks":[{"type":"strong"}]},{"text":"field. This can be either yourself or a user in your domain.","type":"text"}]},{"type":"extension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"rw-step","parameters":{"macroParams":{},"macroMetadata":{"macroId":{"value":"2d173c10-e612-4d86-99bd-d591e7f9e670"},"schemaVersion":{"value":"1"},"placeholder":[{"type":"icon","data":{"url":"https://d1bgdtsfe1sjdg.cloudfront.net/refinedtheme-for-cloud/macro-icons/step.png"}}],"title":"UI Step"}},"localId":"e4d06d73-a3eb-43d7-9258-e70af592b023"}},{"type":"paragraph","content":[{"text":"Select the destination ","type":"text"},{"text":"Target table(s) ","type":"text","marks":[{"type":"strong"}]},{"text":"for the events. These are the tag or tags that will be used by Devo to classify the events. You can use wildcards to send the data to multiple tables. For example, to send the events to all tables that begin with \"my.app\", you can specify ","type":"text"},{"text":"my.app.**","type":"text","marks":[{"type":"strong"}]},{"text":". See the ","type":"text"},{"text":"Authentication tokens","type":"text","marks":[{"type":"link","attrs":{"href":"https://docs.devo.com/confluence/display/NDT/Authentication+tokens"}}]},{"text":" section to learn more about how to use wildcards when identifying target tables.","type":"text"}]},{"type":"panel","attrs":{"panelType":"warning"},"content":[{"type":"paragraph","content":[{"text":"Note that it is not possible to ingest data to tables that receive events in ","type":"text"},{"text":"CEF syslog format","type":"text","marks":[{"type":"link","attrs":{"href":"https://docs.devo.com/confluence/display/NDT/Technologies+supported+in+CEF+syslog+format"}}]},{"text":" using this method.","type":"text"}]}]},{"type":"extension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"rw-step","parameters":{"macroParams":{},"macroMetadata":{"macroId":{"value":"3d3a6fb1-8493-4efe-81b4-0b9ea86ab453"},"schemaVersion":{"value":"1"},"placeholder":[{"type":"icon","data":{"url":"https://d1bgdtsfe1sjdg.cloudfront.net/refinedtheme-for-cloud/macro-icons/step.png"}}],"title":"UI Step"}},"localId":"fe551111-95e6-41bd-82fc-4686e89faff6"}},{"type":"paragraph","content":[{"text":"In the ","type":"text"},{"text":"Type ","type":"text","marks":[{"type":"strong"}]},{"text":"field, choose ","type":"text"},{"text":"HTTP ingestion","type":"text","marks":[{"type":"strong"}]},{"text":".","type":"text"},{"type":"hardBreak"}]},{"type":"mediaSingle","attrs":{"layout":"center"},"content":[{"type":"media","attrs":{"width":476,"id":"a8407ca8-8dd0-4c4c-ac85-39aa87c72f23","collection":"contentId-94641061","type":"file","height":232}}]},{"type":"extension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"rw-step","parameters":{"macroParams":{},"macroMetadata":{"macroId":{"value":"f9671f11-8aed-4990-9c79-2c9aa8117ae5"},"schemaVersion":{"value":"1"},"placeholder":[{"type":"icon","data":{"url":"https://d1bgdtsfe1sjdg.cloudfront.net/refinedtheme-for-cloud/macro-icons/step.png"}}],"title":"UI Step"}},"localId":"74e4c113-ffda-445f-81d4-76d18228a58a"}},{"type":"paragraph","content":[{"text":"Optionally, check the ","type":"text"},{"text":"Expiration date ","type":"text","marks":[{"type":"strong"}]},{"text":"field if you want to enter an expiration date for the new token. Choose the required date in the calendar.","type":"text"}]},{"type":"extension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"rw-step","parameters":{"macroParams":{},"macroMetadata":{"macroId":{"value":"8616ecf6-4a6a-40c3-96b0-122af8716860"},"schemaVersion":{"value":"1"},"placeholder":[{"type":"icon","data":{"url":"https://d1bgdtsfe1sjdg.cloudfront.net/refinedtheme-for-cloud/macro-icons/step.png"}}],"title":"UI Step"}},"localId":"8032f845-3357-48e4-b617-635905c57a2c"}},{"type":"paragraph","content":[{"text":"Click ","type":"text"},{"text":"Accept","type":"text","marks":[{"type":"strong"}]},{"text":". The token is generated and appears in the token list below.","type":"text"}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Configure the HTTP endpoint","type":"text"}]},{"type":"paragraph","content":[{"text":"Once the token has been generated, you can configure the endpoint. The URL to send the HTTP request follows this format:","type":"text"}]},{"type":"codeBlock","content":[{"text":"///token!//?","type":"text"}]},{"type":"paragraph","content":[{"text":"Where each element in the URL is described below:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":" ","type":"text","marks":[{"type":"code"}]},{"text":"- Use the endpoint that corresponds to the Devo Cloud region you use.","type":"text","marks":[{"type":"textColor","attrs":{"color":"#222222"}}]}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"USA","type":"text","marks":[{"type":"strong"}]},{"text":" - ","type":"text"},{"text":"http[s]://http-us.devo.io","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Europe","type":"text","marks":[{"type":"strong"}]},{"text":" - ","type":"text"},{"text":"http[s]://http-eu.devo.io","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"","type":"text","marks":[{"type":"code"}]},{"text":" - This can be either ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#222222"}}]},{"text":"event","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#222222"}},{"type":"em"}]},{"text":"(for sending single events. GET, POST, and PUT accepted) or ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#222222"}}]},{"text":"stream","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#222222"}},{"type":"em"}]},{"text":"(for sending multiple events, POST and PUT accepted). Each mode accepts the HTTP methods as follows:","type":"text","marks":[{"type":"textColor","attrs":{"color":"#222222"}}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":".","type":"text","marks":[{"type":"textColor","attrs":{"color":"#ffffff"}}]},{"text":" ","type":"text","marks":[{"type":"code"}]},{"text":"- The Devo domain the events are being sent to.","type":"text","marks":[{"type":"textColor","attrs":{"color":"#222222"}}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":" ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#222222"}}]},{"text":"","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#222222"}},{"type":"strong"}]},{"text":"- The token you generated in Devo to authorize your connection. ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#222222"}}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":" ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#222222"}}]},{"text":"","type":"text","marks":[{"type":"code"}]},{"text":" - The hostname of the sending host. If unknown, enter \"-\".","type":"text","marks":[{"type":"textColor","attrs":{"color":"#222222"}}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":" ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#222222"}}]},{"text":"","type":"text","marks":[{"type":"code"}]},{"text":" - The Devo tag to apply to the events.","type":"text","marks":[{"type":"textColor","attrs":{"color":"#222222"}}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":" ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#222222"}}]},{"text":"","type":"text","marks":[{"type":"code"}]},{"text":" - The message to be logged.","type":"text","marks":[{"type":"textColor","attrs":{"color":"#222222"}}]}]}]}]},{"type":"paragraph","content":[{"text":"Here is an example of an endpoint URL:","type":"text","marks":[{"type":"textColor","attrs":{"color":"#222222"}}]}]},{"type":"codeBlock","content":[{"text":"http://http-us.devo.io/event/myDomain/token!a5370g9e8f7d7edf9d/local1/my.app.http.js?this%20is%20a%20example%20of%20log","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Code samples","type":"text"}]},{"type":"paragraph","content":[{"text":"Here you can see a few examples of how token-based HTTP requests can be sent from an endpoint to a table (or tables) in a Devo domain. ","type":"text"}]},{"type":"extension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"toc","parameters":{"macroParams":{"maxLevel":{"value":"3"},"minLevel":{"value":"3"}},"macroMetadata":{"macroId":{"value":"51d949c4-5b27-4542-b81d-b02882639074"},"schemaVersion":{"value":"1"},"title":"Table of Contents"}},"localId":"c4289286-a840-4964-a6f3-786ac2a623d3"}},{"type":"heading","attrs":{"level":3},"content":[{"text":"Python - Sending a single event","type":"text"}]},{"type":"codeBlock","content":[{"text":"import requests\nfrom urllib.parse import quote\ndevo_endpoint=\"http://devoEndpoint\"\ndomain=\"demoDomain\"\ntoken=\"example_token_1234abcd\"\nhostname=\"my_src_hostname\"\ndevo_table=\"my.app.demo.send\"\nmessage = quote(\"test event\")\nurl = f'{devo_endpoint}/event/{domain}/token!{token}/{hostname}/{devo_table}?{message}'\npayload={}\nheaders = {}\nrequests.request(\"GET\", url, headers=headers, data=payload)","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Python - Sending a file with events","type":"text"}]},{"type":"codeBlock","content":[{"text":"import requests\nwith open('filePath', 'rb') as f:\ndata = f.read()\ndevo_endpoint=\"http://devoEndpoint\"\ndomain=\"demoDomain\"\ntoken=\"example_token_1234abcd\"\nhostname=\"my_src_hostname\"\ndevo_table=\"my.app.demo.send\"\nurl = f'{devo_endpoint}/event/{domain}/token!{token}/{hostname}/{devo_table}'\nrequests.request(\"POST\", url, data=data)","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Java","type":"text"}]},{"type":"codeBlock","content":[{"text":"package lt.example.http.send;\n\nimport java.io.IOException;\nimport java.io.UnsupportedEncodingException;\nimport java.net.HttpURLConnection;\nimport java.net.URL;\nimport java.net.URLEncoder;\n\npublic class Main {\n // /event//token!//?\n\n public static void main(String[] args) {\n try {\n final String url = generateUrl(\n \"http://devoEndpoint\",\n \"demoDomain\",\n \"example_token_1234abcd\",\n \"my_src_hostname\",\n \"my.app.demo.send\",\n encodeToHttp(\"example_of_log\"));\n\n URL obj = new URL(url);\n HttpURLConnection con = (HttpURLConnection) obj.openConnection();\n con.setRequestMethod(\"GET\");\n int responseCode = con.getResponseCode();\n System.out.println(\"Response Code : \" + responseCode);\n System.out.println(\"Response: \" + con.getResponseMessage());\n } catch (UnsupportedEncodingException e) {\n System.err.println(\"Cannot encode message: \" + e.getMessage());\n e.printStackTrace();\n } catch (IOException e) {\n System.err.println(e.getMessage());\n e.printStackTrace();\n }\n }\n\n public static String encodeToHttp(String str)\n throws UnsupportedEncodingException {\n return URLEncoder.encode(str, \"UTF-8\").replace(\"+\",\"%20\");\n }\n\n public static String generateUrl(String serverPath, String domain,\n String token, String hostname,\n String tag, String msg) {\n\n return new StringBuilder(serverPath)\n .append(\"/event/\")\n .append(domain).append(\"/token!\")\n .append(token).append(\"/\")\n .append(hostname).append(\"/\")\n .append(tag).append(\"?\")\n .append(msg)\n .toString();\n }\n}\n\n","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Java (POST example)","type":"text"}]},{"type":"codeBlock","content":[{"text":"import java.io.IOException;\nimport java.io.UnsupportedEncodingException;\nimport java.net.HttpURLConnection;\nimport java.net.URL;\nimport java.io.DataOutputStream;\n\npublic class Main {\n public static void main(String[] args) {\n try{\n final String url = generateUrl(\n \"http://devoEndpoint\",\n \"demoDomain\",\n \"example_token_1234abcd\",\n \"my_src_hostname\",\n \"my.app.demo.send\");\n\n URL obj = new URL(url);\n HttpURLConnection con = (HttpURLConnection) obj.openConnection();\n con.setRequestMethod(\"POST\");\n con.setRequestProperty(\"Content-Type\", \"application/x-www-form-urlencoded\");\n con.setRequestProperty(\"charset\", \"utf-8\");\n con.setDoOutput(true);\n \n String urlParameters;\n DataOutputStream wr = new DataOutputStream(con.getOutputStream());\n \n for (int i = 0; i < 3; i++) {\n urlParameters = \"PostExample\" + i + \"\\n\"; // \\n needed to send multiple events, otherwise the stream will be sent as a single event\n wr.writeBytes(urlParameters);\n }\n\n wr.flush();\n wr.close();\n int responseCode = con.getResponseCode();\n System.out.println(\"Response Code : \" + responseCode);\n System.out.println(\"Response: \" + con.getResponseMessage());\n\n } catch (UnsupportedEncodingException e) {\n System.err.println(\"Cannot encode message: \" + e.getMessage());\n e.printStackTrace();\n } catch (IOException e) {\n System.err.println(e.getMessage());\n e.printStackTrace();\n }\n }\n\n public static String generateUrl(String serverPath, String domain,\n String token, String hostname,\n String tag) {\n\n return new StringBuilder(serverPath)\n .append(\"/stream/\")\n .append(domain).append(\"/token!\")\n .append(token).append(\"/\")\n .append(hostname).append(\"/\")\n .append(tag).append(\"?\")\n .toString();\n }\n}\n","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"HTML - jQuery","type":"text"}]},{"type":"codeBlock","content":[{"text":"\n\n\n \n Devo: JQuery Example\n \n \n\n\n

JQuery Example

\n\n\n\n","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"HTML - JavaScript","type":"text"}]},{"type":"codeBlock","content":[{"text":"\n\n\n \n Devo: JavaScript Example\n \n\n\n

JS Example

\n\n","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"cURL - Sending a single event","type":"text"}]},{"type":"codeBlock","content":[{"text":"curl -v ‘/event//token!//?this%20is%20a%20example%20of%20log’","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"cURL - Sending a file with events","type":"text"}]},{"type":"codeBlock","content":[{"text":"curl -v --request POST --url '/stream//token!//' --header 'Content-Type:application/x-www-form-urlencoded' --header 'charset:utf-8' --data-binary @","type":"text"}]},{"type":"paragraph","content":[{"text":".","type":"text","marks":[{"type":"textColor","attrs":{"color":"#ffffff"}}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Related articles","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Security credentials","type":"text","marks":[{"type":"link","attrs":{"href":"https://devodocs.atlassian.net/wiki/pages/createpage.action?spaceKey=NDT5&title=Security%20credentials"}}]}]}]}]},{"type":"paragraph","content":[{"type":"hardBreak"}]}],"version":1}

Browser not supported